diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index cb4d90850..af36c3d66 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -12,4 +12,4 @@ # review when someone opens a pull request. -* @skarred14 @ognjenkurtic @therecanbeonlyone1969 @Kasshern @ybittan @biscuitdey @skosito +* @skosito @ognjenkurtic @therecanbeonlyone1969 @biscuitdey diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0d7988af4..1dc45fde2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,11 +4,11 @@ __Baseline__ is an open-source project that is actively seeking contributions fr ## First-time contributors -If you are new to the baseline project and are looking for an entry-point to make your first contribution, look [here](https://github.com/ethereum-oasis/baseline/issues?q=is%3Aopen+is%3Aissue+label%3A%22%3Astar_struck%3A+good+first+issue%22). That link shows all of the tagged `good first issues`, which are meant to be small pieces of work that a first-time contributor can pick-up and complete. If you find one that you'd like to work on, please assign yourself or comment on the issue and one of the maintainers can assign it for you. +If you are new to the baseline project and are looking for an entry-point to make your first contribution, look [here](https://github.com/ethereum-oasis-op/baseline/issues?q=is%3Aopen+is%3Aissue+label%3A%22%3Astar_struck%3A+good+first+issue%22). That link shows all of the tagged `good first issues`, which are meant to be small pieces of work that a first-time contributor can pick-up and complete. If you find one that you'd like to work on, please assign yourself or comment on the issue and one of the maintainers can assign it for you. ## Submitting a new issue -If you want to create a new issue that doesn't exist already, follow the guidelines in one of our [Issue Templates](https://github.com/ethereum-oasis/baseline/tree/master/.github/ISSUE_TEMPLATE). +If you want to create a new issue that doesn't exist already, follow the guidelines in one of our [Issue Templates](https://github.com/ethereum-oasis-op/baseline/tree/main/.github/ISSUE_TEMPLATE). ## Submitting a new pull request @@ -48,4 +48,4 @@ In the commit message, always continue the sentence "This commit does ...". Exam Anyone can do a pull request and commit. In order for your work to be merged, you will need to sign the eCLA (entity contributor agreement) if you are contributing on behalf of your company, or iCLA (individual contributor agreement) if you are just contributing for yourself. [Learn more about the eCLA here.](https://www.oasis-open.org/resources/projects/cla/projects-entity-cla) -The iCLA is administered by a bot which will comment on your PR and direct you to sign the iCLA if you haven’t previously done so. This happens automatically when people submit a pull request, or they can access directly by going to [https://cla-assistant.io/eea-oasis/managed-open-project](https://cla-assistant.io/eea-oasis/managed-open-project). +The iCLA is administered by a bot which will comment on your PR and direct you to sign the iCLA if you haven’t previously done so. This happens automatically when people submit a pull request, or they can access directly by going to [https://cla-assistant.io/ethereum-oasis-op/managed-open-project](https://cla-assistant.io/ethereum-oasis-op/managed-open-project). diff --git a/LICENSE.md b/LICENSE.md index 4f2a52c30..f13a4aa15 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -5,7 +5,7 @@ so that notice of them may be posted. For information on any statements regarding IPR claims related to the work of this project, see the -[OASIS OP IPR Statements](https://github.com/oasis-open-projects/administration/blob/master/IPR_STATEMENTS.md) +[OASIS OP IPR Statements](https://github.com/oasis-open-projects/administration/blob/main/IPR_STATEMENTS.md) page. # CC0 1.0 Universal diff --git a/MAINTAINERS.md b/MAINTAINERS.md index b47cc258c..773a8a3fe 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -18,12 +18,10 @@ They can/should also contribute in the following ways: Code and Systems maintainers -- [Yoav Bittan](https://github.com/Ybittan) - [Biswashree Dey](https://github.com/biscuitdey) - [Andreas Freund](https://github.com/Therecanbeonlyone1969) - [Ognjen Kurtic](https://github.com/ognjenkurtic) -- [Keith Salzman](https://github.com/Kasshern) -- [Kartheek Solipuram](https://github.com/skarred14) +- [Stefan Kostic](https://github.com/skosito) # How to become a maintainer? @@ -61,9 +59,9 @@ In general, a maintainer needs to: Maintainers meet and discuss issues virtually via the private #maintainers slack room in the [baseline slack](https://ethereum-baseline.slack.com/). -## Bi-Weekly Meetings +## Maintainer Meetings -There are Bi-Weekly _Maintainers meetings_(https://us06web.zoom.us/j/88974739050?pwd=M2w1THFHdzBkaXp0STZtWXQyZXlYQT09) where members can discuss plans and issues related to the project, updates, release planning, and other related topics. These meetings are not public but special exceptions can be granted for members of the baseline community, experts, or other key participants. The summaries of the meetings will be posted to the public #maintainer-meeting slack room. +Currently paused as the community regroups. # How to stop being a maintainer? diff --git a/README.md b/README.md index 392c2120f..8c1523e72 100644 --- a/README.md +++ b/README.md @@ -4,36 +4,64 @@ description: Learn more at baseline-protocol.org # Welcome -## Welcome to the Baseline Protocol Community +## Welcome to the Baseline Community The Baseline Protocol is a standard that enables enterprises to synchronize complex, multiparty, business processes with privacy and without moving data from systems of record. -There are many ways to[ **learn more**](https://www.baseline-protocol.org)**,** [**get involved**](https://www.baseline-protocol.org/get-involved/)**,** [**get 'Baselined'**](https://www.baseline-protocol.org/get-baselined/), and get value out of developing reusable components to ultimately deploy the [Baseline Protocol standard](https://github.com/eea-oasis/baseline-standard) in your own offerings. +There are many ways to[ **learn more**](https://www.baseline-protocol.org)**,** [**get involved**](https://www.baseline-protocol.org/get-involved/)**,** [**get 'Baselined'**](https://www.baseline-protocol.org/get-baselined/), and get value out of developing reusable components to ultimately deploy the [Baseline Protocol standard](https://github.com/ethereum-oasis-op/baseline-standard) in your own offerings. -## About the Baseline Protocol +## New Community Focus -The Baseline Protocol is the emerging standard for state synchronization across different systems of record. This applies to traditional corporate systems of record, any kind of database or [state machine](https://www.techopedia.com/definition/16447/state-machine), and even different blockchains or distributed ledger technologies (DLTs). It is particularly beneficial as a way to reduce capital expense and other overheads, while increasing operational integrity and information security when **automating and synchronizing business processes** across multiple companies. +After the completion of the Baseline Protocol Standard and the reference implementation BRI-3, the community experienced a decline in activity. To revitalize and refocus the community, the remaining members obtained a grant from the EU Trustchain to build interoperability tests and demonstrate the protocol's potential in real-world scenarios. -The Baseline Protocol initiative was [announced](https://consensys.net/blog/press-release/ey-and-consensys-announce-formation-of-baseline-protocol-initiative-to-make-ethereum-mainnet-safe-and-effective-for-enterprises/) on March 4, 2020, and launched as an [OASIS Open Source Project](https://oasis-open-projects.org) on March 19, 2020, supported by fourteen founding companies. More companies joined the effort shortly thereafter and continue to do so. In 2021, the Enterprise Ethereum Alliance and OASIS collaborated to establish the Baseline Protocol as an [EEA Community Project](https://entethalliance.org/eeacommunityprojects/#:\~:text=The%20EEA%20Community%20Projects%2C%20formerly,API%20documentation%20under%20its%20stewardship.). There are many notable, industry leading, companies sponsoring the Baseline Protocol, [see the list of sponsors](https://www.baseline-protocol.org/become-a-sponsor/) and learn how to become a sponsor and benefits [here](https://www.baseline-protocol.org/become-a-sponsor/). +The community now focuses on financial inclusion and ESG (Environmental, Social, and Governance) as primary drivers. This pivot is driven by the recognition that the Baseline Protocol can play a crucial role in addressing significant global challenges, such as bridging the SME financing gap in developing regions and promoting sustainable business practices. -The work of the community is maintained under a [public domain license](https://github.com/eea-oasis/baseline/blob/main/LICENSE). +### Rationale for the Pivot + +1. **Financial Inclusion**: The Baseline Protocol Interoperability Demo showcases a use-case with potentially huge economic impact - bridging the SME financing gap in developing regions. By enabling efficient and verifiable data exchange processes, the protocol can help small-scale invoice financing operations attract large debt providers, aggregate fragmented portfolios across jurisdictions, and standardize origination procedures. This can lead to safer and more efficient lending practices, ultimately fostering economic growth and financial inclusion. + +2. **Environmental, Social, and Governance (ESG)**: The community recognizes the importance of ESG factors in modern business practices. By focusing on ESG, the Baseline Protocol can help organizations automate and synchronize business processes in a way that promotes transparency, accountability, and sustainability. This aligns with the growing demand for businesses to adopt responsible practices that benefit society and the environment. + +The community's brand statement, "Baseline Inside," reflects this renewed focus on leveraging the Baseline Protocol to drive positive change in financial inclusion and ESG. + +## About Baseline + +The Baseline Protocol is the global standard for state synchronization across different systems of record. This applies to traditional corporate systems of record, any kind of database or [state machine](https://www.techopedia.com/definition/16447/state-machine), and even different blockchains or distributed ledger technologies (DLTs). It is particularly beneficial as a way to reduce capital expense and other overheads, while increasing operational integrity and information security when **automating and synchronizing business processes** across multiple companies. + +The Baseline Protocol initiative was [announced](https://consensys.net/blog/press-release/ey-and-consensys-announce-formation-of-baseline-protocol-initiative-to-make-ethereum-mainnet-safe-and-effective-for-enterprises/) on March 4, 2020, and launched as an [OASIS Open Source Project](https://oasis-open-projects.org) on March 19, 2020, supported by fourteen founding companies. More companies joined the effort shortly thereafter and continue to do so. In 2021, the Enterprise Ethereum Alliance and OASIS collaborated to establish the Baseline Protocol as an [EEA Community Project](https://entethalliance.org/eeacommunityprojects/#:\~:text=The%20EEA%20Community%20Projects%2C%20formerly,API%20documentation%20under%20its%20stewardship.). + +Baseline Protocol Sponsors, [see the list of sponsors](https://www.baseline-protocol.org/become-a-sponsor/). Learn how to become a sponsor and benefits [here](https://www.baseline-protocol.org/become-a-sponsor/). + +The work of the community is maintained under a [public domain license](https://github.com/ethereum-oasis-op/baseline/blob/main/LICENSE). **New Contributors to the repository and standard, see** [**contribution guidelines here**](community/contributors.md#code-of-conduct)**.** ## The Baseline Protocol Source Code -Version 1.0 of the Baseline Protocol has been released. It is composed of a set of 6 core packages that are open-sourced, under the [CC0 1.0 Universal public domain](https://github.com/eea-oasis/baseline/blob/main/LICENSE) dedication. +Version 1.0 of the Baseline Protocol has been released. It is composed of a set of 6 core packages that are open-sourced, under the [CC0 1.0 Universal public domain](https://github.com/ethereum-oasis-op/baseline/blob/main/LICENSE) dedication. **You can find more about the** **source code** [**here**](docs/baseline-protocol-code/packages/)**.** ## The Baseline Protocol Standard -The [Baseline Protocol Specifications ](https://github.com/eea-oasis/baseline-standard)were completed in September 2021 and is undergoing ratification to become an [OASIS Open Standard](https://www.oasis-open.org/standards/), available under the [CC0 1.0 Universal public domain](https://github.com/eea-oasis/baseline/blob/main/LICENSE) dedication. +The [Baseline Protocol Specifications ](https://github.com/ethereum-oasis-op/baseline-standard) were completed in September 2021 and is undergoing ratification to become an [OASIS Open Standard](https://www.oasis-open.org/standards/), available under the [CC0 1.0 Universal public domain](https://github.com/ethereum-oasis-op/baseline/blob/main/LICENSE) dedication. -The Baseline Protocol Standard contains three specifications - [CORE](https://github.com/eea-oasis/baseline-standard/tree/main/core), [API](https://github.com/eea-oasis/baseline-standard/tree/main/api), and [CCSM](https://github.com/eea-oasis/baseline-standard/tree/main/ccsm), that provide the requirements of a compliant Baseline Protocol Implementation (BPI). +The Baseline Protocol Standard contains three specifications - [CORE](https://github.com/ethereum-oasis-op/baseline-standard/tree/main/core), [API](https://github.com/ethereum-oasis-op/baseline-standard/tree/main/api), and [CCSM](https://github.com/ethereum-oasis-op/baseline-standard/tree/main/ccsm), that provide the requirements of a compliant Baseline Protocol Implementation (BPI). -**Find full details on the** [**Baseline Protocol Standard here**](https://github.com/eea-oasis/baseline-standard)**.** +**Find full details on the** [**Baseline Protocol Standard here**](https://github.com/ethereum-oasis-op/baseline-standard)**.** ## The Baseline Protocol Reference Implementations -A growing number of Baseline Protocol Reference Implementations can be found [here](docs/bri/overview-of-reference-implementations.md). Demos and examples can be found [here](https://github.com/ethereum-oasis/baseline/tree/master/examples). These are intended to help you understand baselining and give you ideas for your implementation needs. +A growing number of [Baseline Protocol Reference Implementations](docs/bri/overview-of-reference-implementations.md), along with [demonstrations and examples]https://github.com/ethereum-oasis-op/baseline/tree/main/examples) are available to help you understand baselining and give you ideas for your implementation needs. + +## Baseline Protocol Interoperability Demo based on an EU Trustchain grant + +The Baseline Protocol Interoperability Demo focuses on a use-case with potentially huge economic impact - bridging the SME financing gap in the developing regions. The scenario involves multiple stakeholders including invoice financing companies, large debt providers, and regulatory bodies, participating in what should be an efficient and verifiable data exchange process that would allow the debt providers to safely and efficiently lend money to the invoice financing companies. + +The current financing landscape faces significant challenges due to: +- Small-scale invoice financing operations unable to attract large debt providers +- Fragmented portfolios across jurisdictions +- Non-standardized origination procedures +- Complex regulatory requirements + +The challenge is to develop a solution that enables portfolio aggregation while ensuring standardized origination processes and independent verification capabilities. The proposed approach leverages a modular software protocol to achieve these objectives while maintaining process integrity across all participating entities. diff --git a/TECHNICAL-STEERING-COMMITTEE.md b/TECHNICAL-STEERING-COMMITTEE.md index c162effb7..c3e4dc76a 100644 --- a/TECHNICAL-STEERING-COMMITTEE.md +++ b/TECHNICAL-STEERING-COMMITTEE.md @@ -4,12 +4,12 @@ The group is responsible for reviewing and approving proper use of the grant fun The following people were elected to serve on the Baseline TSC from November 2023 to November 2024 (in alphabetical order): +* Ryan Fleischman * Andreas Freund -* Biswashree Dey * Kartheek Solipuram -* Mehran Shakeri * Ognjen Kurtic -* Ryan Fleischmann * Sonal Patel +The new TSC is currently being reconstituted. + You can reach the TSC via the [mailing list](mailto:baseline-tsc@lists.oasis-open-projects.org). diff --git a/community/community-leaders.md b/community/community-leaders.md index 64648f9e6..b2ab78f35 100644 --- a/community/community-leaders.md +++ b/community/community-leaders.md @@ -12,50 +12,41 @@ The project governance board (PGB) is organized by OASIS and is accountable for ### Community Organizers -OASIS employs key personnel that support all the open standards and open source projects under its domain. In addition, the Enterprise Ethereum Alliance maintains a team that also supports EEA Community Projects such as the Baseline Protocol. And finally, members such as ConsenSys have assigned key personnel specifically to support and organize the community. +OASIS employs key personnel that support all the open standards and open source projects under its domain. And members have assigned key personnel specifically to support and organize the community. | Name | Organization | | ---------------- | ------------ | | Claudia Rauch | OASIS | -| Carol Geyer | OASIS | | Chet Ensign | OASIS | -| Sonal Patel | ConsenSys MESH| +| Sonal Patel | Interweave Technologies| | Andreas Freund | Ethereum Foundation| ### Technical Steering Committee 2022/23 The technical steering committee (TSC) is accountable to the Project Governance Board for managing conflicts on merges and Core Dev self-organization. It also governs the allocation of grant money. And it meets regularly to set technical roadmaps and ensure progress of the community toward the ubiquitous implementation of the baseline protocol in systems of record everywhere. +* Ryan Fleischman * Andreas Freund * Kartheek Solipuram -* Keith Salzman -* Manik Jain -* Marc Haddle -* Mehran Shakeri * Ognjen Kurtic -* Samrat Kishor * Sonal Patel -* Stefan Kostic -* Yoav Bittan ### Maintainers Team The Maintainers are a subset of the contributing members of the community who have demonstrated leadership and teamwork and approve all contributions before merging them to the Main branch of the repo. -Details on how to become a [Maintainer here](https://github.com/eea-oasis/baseline/blob/main/MAINTAINERS.md#how-to-become-a-maintainer). +Details on how to become a [Maintainer here](https://github.com/ethereum-oasis-op/baseline/blob/main/MAINTAINERS.md#how-to-become-a-maintainer). Maintainer (with link to Github ID): -- [Yoav Bittan](https://github.com/Ybittan) - [Biswashree Dey](https://github.com/biscuitdey) - [Andreas Freund](https://github.com/Therecanbeonlyone1969) - [Ognjen Kurtic](https://github.com/ognjenkurtic) -- [Keith Salzman](https://github.com/Kasshern) -- [Kartheek Solipuram](https://github.com/skarred14) +- [Stefan Kostic](https://github.com/skosito) ## Standards Team -The standards team worked through most of 2021 to develop a world-class technical specification that implementers and test developers can use to ensure compliance with the baseline protocol specification. The draft will now be shepherded through the OASIS process of review and amendments, culminating in becoming an official OASIS standard. Standards writing is hard, and reviewing the writing is equally hard. This team deserves the highest regard from the community for its hard-toiling service and commitment to excellence. +The Standards team worked through most of 2021 to develop a world-class technical specification that implementers and test developers can use to ensure compliance with the baseline protocol specification. The draft will now be shepherded through the OASIS process of review and amendments, culminating in becoming an official OASIS standard. Standards writing is hard, and reviewing the writing is equally hard. This team deserves the highest regard from the community for its hard-toiling service and commitment to excellence. | Member | Company | | -------------- | ------------------ | @@ -64,9 +55,11 @@ The standards team worked through most of 2021 to develop a world-class technica | Yoav Bittan | ConsenSys Mesh | | Chaale Neville | EEA | +The Standards Team's work is paused until after Project Specification Draft (PSD) Ratification. See link to standard for details [here](https://github.com/ethereum-oasis-op/baseline-standard) + ## Outreach Team -The outreach team consists of writers, evangelists, stakeholders, sponsors, events organizers and marketers who work together to develop enablement materials, promote baselining in the media, events and through direct engagement with thought leaders and decision-makers. The Outreach Team is currently looking for members. +The outreach team should consist of writers, evangelists, stakeholders, sponsors, events organizers and marketers who work together to develop enablement materials, promote Baseline and "Baseline Inside" in the media, events and through direct engagement with thought leaders and decision-makers. The Outreach Team is currently looking for members. | Member | Company | | ---------------------------------- | ------- | diff --git a/community/contributors.md b/community/contributors.md index 6c84485cf..a84d2bf7e 100644 --- a/community/contributors.md +++ b/community/contributors.md @@ -1,12 +1,12 @@ --- description: >- - Anyone can contribute to the Baseline Protocol by making technical, + Anyone can contribute to Baseline by making technical, specification related, or other contributions --- # Contributors -All technical and standards-related work of the Baseline Protocol initiative is maintained publicly on the [**github repo**](https://github.com/ethereum-oasis/baseline) **** and [**open source team**](open-source-community.md) work is managed in Google Drives by community managers. [**Sign up to join** the teams](open-source-community.md) or **email at baseline-team@oasis-open.org** for access to the open source team work. +All technical and standards-related work of the Baseline initiative is maintained publicly on the [**github repo**](https://github.com/ethereum-oasis-op/baseline) **** and [**open source team**](open-source-community.md) work is managed in Google Drives by community managers. [**Sign up to join** the teams](open-source-community.md) or **email at baseline-team@oasis-open.org** for access to the open source team work. Anyone can get involved and start contributing by joining the open source teams, taking on work, proposing grant work, or even directly submitting an issue or PR to the repository. @@ -23,7 +23,7 @@ There is one other way to contribute, and it's the most important: **use the wor Here is the link to the Baseline Protocol code of conduct: -{% embed url="https://github.com/ethereum-oasis/baseline/blob/master/CODE_OF_CONDUCT.md" %} +{% embed url="https://github.com/ethereum-oasis-op/baseline/blob/main/CODE_OF_CONDUCT.md" %} ## Technical Contributors @@ -31,9 +31,7 @@ Technical contributors either are working on architecture or developing code...b ## Core Developers -Once you've done some work as a Member, you may wish to become a **Core developer** and have a direct hand in deciding what work is merged to the Main/Master Branch to become official Baseline Protocol technology and specifications. - -Here's a list of [current Core Developers](broken-reference). +Once you've done some work as a Member, you may wish to become a [**Maintainer**](https://github.com/ethereum-oasis-op/baseline/blob/main/MAINTAINERS.md) and have a direct hand in deciding what work is merged to the Main Branch to become official Baseline technology and specifications. ### What do core developers do? @@ -51,11 +49,11 @@ They can/should also contribute in the following ways: * Working with the community to help with adoption * Presenting the project and key technologies to the public (in-person, webinar, videos, articles, etc...) -## How to become a core developer? +## How to become a maintainer? -There are two ways to become a core developer: You are asked by a current core developer, or you make request to an existing core developer to become one. +There are two ways to become a maintainer: You are asked by a current maintainer, or you make request to an existing maintainer to become one. -With either path you become a "provisional core developer". As such you will need to show consistent contributions of code and/or specifications to the project. This can be in the form of pull requests that get merged into master. Or it can be in the form of technical specification, system architecture and related artifacts that guide the development activities of others. +With either path you become a "provisional maintainer". As such you will need to show consistent contributions of code and/or specifications to the project. This can be in the form of pull requests that get merged into master. Or it can be in the form of technical specification, system architecture and related artifacts that guide the development activities of others. All provisional core developers that focus on code development (over standards) must meet with the existing core developers and demonstrate they are capable of the following: @@ -64,11 +62,11 @@ All provisional core developers that focus on code development (over standards) * Explaining the components of the system architecture * Walking through the code and explain the baseline process -Once the provisional core developer demonstrates their capabilities, the existing core developers will vote during the next scheduled core developer meeting to give the prospect full core developer status. Members must vote with 2/3rds majority to add a core developer. Voting that results in a tie or potentially other issue will be brought to the TSC for review. +Once the provisional maintainer demonstrates their capabilities, the existing core developers will vote during the next scheduled maintainer meeting to give the prospect full maintainer status. Members must vote with 2/3rds majority to add a maintainer. Voting that results in a tie or potentially other issue will be brought to the TSC for review. ## What is expected of core developers? -In general, a core developer needs to: +In general, a maintainer needs to: * be an expert in one or more fields related to the project * be an expert in finding and engaging the advice of other experts @@ -90,24 +88,24 @@ Core Developers meet and discuss issues virtually via the #maintainers slack roo ### Regular Meetings -There are weekly _Core Developers meetings_ where members can discuss plans and issues related to the project, updates, release planning, and other related topics. Anyone may attend these meetings, but the primary participants are core developers. Core developers are required to produce meeting summaries and document decisions. +There are currently no regular meetings. Meeting signups are maintained on the "Join the Community" page on https://baseline-protocol.org. -## How to stop being a core developer? +## How to stop being a maintainer? Any of the following ways: * You stop reviewing PR's, responding to messages, answering emails, and/or generally ghost the project. * You are disrespectful towards anyone in the community and/or involved in the project. * You are disruptive to the general process of maintaining the project, meetings, discussions, issues, or other. -* You notify the other core developers you would like to relinquish your core developer status. +* You notify the other core developers you would like to relinquish your maintainer status. -Two-thirds of all current core developers constitute a quorum for a meeting involving a question of removal. A simple majority vote from core developers attending the meeting is required to remove a core developer, but the TSC may be brought in to arbitrate if the core developer to be removed or any other core developer wishes to dispute the action. (See [Governance](https://github.com/eea-oasis/baseline/blob/main/docs/governance/governance.md) for details.) +Two-thirds of all current core developers constitute a quorum for a meeting involving a question of removal. A simple majority vote from core developers attending the meeting is required to remove a maintainer, but the TSC may be brought in to arbitrate if the maintainer to be removed or any other maintainer wishes to dispute the action. (See [Governance](https://github.com/ethereum-oasis-op/baseline/blob/main/docs/governance/governance.md) for details.) ### BLIPs -As of October 1, 2021, the baseline community will organize work in a similar fashion to Ethereum's EIPs (Ethereum Improvement Proposal). These will be called BaseLine Improvement Proposals, or BLIPs for short, and they will be maintained [here](https://github.com/eea-oasis/baseline-blips/issues). YOU ARE ENCOURAGED TO SUBMIT IDEAS to the BLIP repo, and we are well-organized to review and act on them in a timely fashion. You never know -- we might decide to raise a grant to pay for your idea to get executed. It's happened before. Try it out! +As of October 1, 2021, the baseline community will organize work in a similar fashion to Ethereum's EIPs (Ethereum Improvement Proposal). These will be called BaseLine Improvement Proposals, or BLIPs for short, and they will be maintained [here](https://github.com/ethereum-oasis-op/baseline-blips/issues). YOU ARE ENCOURAGED TO SUBMIT IDEAS to the BLIP repo, and we are well-organized to review and act on them in a timely fashion. You never know -- we might decide to raise a grant to pay for your idea to get executed. It's happened before. Try it out! ### Issues Organization and Community "Sprints" @@ -126,7 +124,7 @@ Follow these steps when submitting a pull request: 1. Fork the repo into your GitHub account. Read more about forking a repo on Github [here](https://help.github.com/articles/fork-a-repo/). 2. Create a new branch, based on the `master` branch, with a name that concisely describes what you’re working on (ex. `add-mysql`). 3. Ensure that your changes do not cause any existing tests to fail. -4. Submit a pull request against the `master` branch. +4. Submit a pull request against the `main` branch. Good practice strongly favors committing work frequently and not loading up a long period of work in isolation. Be brave...let others see what you are working on, even if it isn't "ready." @@ -134,11 +132,11 @@ Good practice strongly favors committing work frequently and not loading up a lo Anyone can do a pull request and commit work to the community. In order for your work to be merged, you will need to sign the eCLA (entity contributor agreement) or iCLA (individual contributor agreement). Here are the details: [https://www.oasis-open.org/resources/projects/cla/projects-entity-cla](https://www.oasis-open.org/resources/projects/cla/projects-entity-cla)​ -The iCLA happens automatically when people submit a pull request, or they can access directly by going to [https://cla-assistant.io/ethereum-oasis/baseline](https://cla-assistant.io/ethereum-oasis/baseline)​ +The iCLA happens automatically when people submit a pull request, or they can access directly by going to [https://cla-assistant.io/ethereum-oasis-op/baseline](https://cla-assistant.io/ethereum-oasis-op/baseline)​ ### Core Developers and Commit Rules -Merging to Master requires review by THREE Core Developers. The TSC seeded the initial set of Core Developers. Now, any active Member can become a Core Developer. Core Developers may add more Core Developers by rough consensus, and the TSC may step in to resolve cases where this process fails. +Merging to Master requires review by THREE Maintainers. The TSC seeded the initial set of Core Developers. Now, any active Member can [become a Maintainer](MAINTAINERS.md#how-to-become-a-maintainer). The Maintainers, collectively, may add more Maintainers by rough consensus, and the TSC may step in to resolve cases where this process fails. ## Specifications Contributors @@ -146,7 +144,7 @@ The specifications work of the community can be done by anyone, both technical a ### Epics and Stories Organization -The Baseline Protocol initiative uses [Zenhub](https://app.zenhub.com/workspaces/baseline-5e713dc4f555144d9d6d17f6/roadmap) to create and manage both [specification](https://github.com/eea-oasis/baseline-standard) work and active protocol requirements and prioritization. (Zenhub should be a tab in your Github interface if you are using the [Chrome extension](https://chrome.google.com/webstore/detail/zenhub-for-github/ogcgkffhplmphkaahpmffcafajaocjbd?hl=en-US). There is also a web-app [here](https://app.zenhub.com/workspaces/baseline-5e713dc4f555144d9d6d17f6/roadmap).) +The Baseline Protocol initiative uses [Zenhub](https://app.zenhub.com/workspaces/baseline-5e713dc4f555144d9d6d17f6/roadmap) to create and manage both [specification](https://github.com/ethereum-oasis-op/baseline-standard) work and active protocol requirements and prioritization. (Zenhub should be a tab in your Github interface if you are using the [Chrome extension](https://chrome.google.com/webstore/detail/zenhub-for-github/ogcgkffhplmphkaahpmffcafajaocjbd?hl=en-US). There is also a web-app [here](https://app.zenhub.com/workspaces/baseline-5e713dc4f555144d9d6d17f6/roadmap).) Zenhub enables Epics to nest, while Issues don't nest...not really. Therefore, the community will employ the practice of using Issues for engineering Tasks and Epics to contain high level topics, which may have nested within them a set of agile Epics, and in them a set of Stories, and even Stories may have other Stories nested in them. Engineering meets planning where a Story (in the form of a Zenhub Epic) is referenced by an Issue/Task. (This can work very well, but Zenhub's choice in calling Epics, _Epics_ can cause confusion. @@ -162,4 +160,4 @@ A Zenhub "Epic" used as a Story should almost always follow the form: "As X, I n ## ​Contributors -The active contributors and maintainers of the Baseline Protocol repo can be found on [Github](https://github.com/ethereum-oasis/baseline/graphs/contributors). (Note: many contributors work in clones extending the protocol for their products. These people don't necessarily show up in the Github contributors list.) +The active contributors and maintainers of the Baseline repo can be found on [Github](https://github.com/ethereum-oasis-op/baseline/graphs/contributors). (Note: many contributors work in clones extending the protocol for their products. These people don't necessarily show up in the Github contributors list.) diff --git a/community/members.md b/community/members.md index 6da8044cc..60f9825a7 100644 --- a/community/members.md +++ b/community/members.md @@ -1,18 +1,18 @@ # General Members -Anyone with a github ID can be a [Contributor](contributors.md) to the Baseline Protocol, but you can also become a **Member** of our Github Organization, which will allow you to get invitations to key meetings, be assigned to Issues, and vote for Technical Steering Committee members (provided you make at least one contribution that is successfully merged to master within the [voting period](../docs/governance/governance.md#steady-state-periods)). +Anyone with a github ID can be a [Contributor](contributors.md) to Baseline and its Protocol, but you can also become a **Member** of our Github Organization, which will allow you to get invitations to key meetings, be assigned to Issues, and vote for Technical Steering Committee members (provided you make at least one contribution that is successfully merged to master within the [voting period](../docs/governance/governance.md#steady-state-periods)). ## What it means to be a Member Being a Member gives you [Write](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization) access to the Github Repo as well as the [Zenhub extension](https://help.zenhub.com/support/solutions/articles/43000037261-github-permissions-and-access-in-zenhub). -Members can manage Issues in pipelines, assign others to Issues, create Epics and Milestones and push contributions to any unprotected branch other than Master/Main. +Members can manage Issues in pipelines, assign others to Issues, create Epics and Milestones and push contributions to any unprotected branch other than Main. It's a good idea to become a member if you are making regular contributions and want to be assigned Issues, be responsible for assigning Issues to others, or both. Members can be technical contributors, contributors to specifications, or people stepping up to be accountable for projects. ## How to Join the Org as a Member -Joining the Baseline Protocol as a Member is easy. +Joining Baseline as a Member is easy. **Technical contributors** should contribute at least one [**pull request**](contributors.md#submitting-a-pull-request). Then, use the #github-membership-requests [**Slack Channel**](https://ethereum-baseline.slack.com/archives/C011XCW8T3Q) to post your github ID, name and company (optional) and a coordinator will ensure that you are added as a member within 24 hours or less. If you do not receive a response in that time, use one of our [chat channels](open-source-community.md#slack-discourse-telegram) to contact the [TSC Chair](community-leaders.md#your-provisional-chair) and/or any member of the [TSC](community-leaders.md#your-technical-steering-committee) to expedite. @@ -30,13 +30,13 @@ Members should: * be reliable in completing issues to which they have been assigned * attend regular member meetings when possible * follow the project style and testing guidelines -* show an understanding of the nature and focus of the Baseline Protocol +* show an understanding of the nature and focus of Baseline * be welcoming to others in the community * follow branch, PR, and code/docs style conventions ## Code of Conduct -Of course, all members must respect and adhere to the community's [code of conduct](https://github.com/ethereum-oasis/baseline/blob/master/CODE\_OF\_CONDUCT.md). +Of course, all members must respect and adhere to the community's [code of conduct](https://github.com/ethereum-oasis-op/baseline/blob/main/CODE\_OF\_CONDUCT.md). ## Removal @@ -46,6 +46,6 @@ Any member may request a confidential review of another member to determine whet Once you are a member, you can: -1. Become a [Core Developer ](broken-reference)responsible for governing the contributions that get merged to the official master branch; +1. Become a [Maintainer ](broken-reference)responsible for governing the contributions that get merged to the official master branch; 2. Get elected to the [Technical Steering Committee](../docs/governance/technical-steering-committee.md), accountable for architecture and governance of the core developers; 3. Or, just write awesome code, specifications, docs and communications. diff --git a/community/open-source-community.md b/community/open-source-community.md index 5ff775cca..180f603ce 100644 --- a/community/open-source-community.md +++ b/community/open-source-community.md @@ -1,6 +1,6 @@ --- description: >- - The Baseline Protocol community is governed as an open source community + The Baseline community is governed as an open source community project --- @@ -8,20 +8,20 @@ description: >- The number of active companies and individuals contributing to the work and using it in products and enterprise solutions is rapidly growing. -Our open source team members are the drivers of the development and adoption of the Baseline Protocol. The work is active and always open to new members. +Our open source team members are the drivers of the development and adoption of Baseline and its Protocol. The work is active and always open to new members. ### **Resources** -Anyone can become a member or learn more about the Baseline Protocol through the following resources +The following resources provide more information about becoming a member: -* ****[**Get Involved**](https://www.baseline-protocol.org/get-involved/)**-** sign up and get involved in our open source teams +* ****[**Get Involved**](https://www.baseline-protocol.org/get-involved/)**-** sign up and get involved in our open source teams * [**Community Member Starter Kit**](https://www.baseline-protocol.org/resources/)**-** understand how you can contribute as a community member and how the open source community operates * [**Slack**](https://join.slack.com/t/ethereum-baseline/shared\_invite/zt-d6emqeci-bjzBsXBqK4D7tBTZ40AEfQ)**-** join our community Slack, say hello, or ask a question * ****[**Learn more**](https://www.baseline-protocol.org/resources/)- about the Baseline Protocol ## **Teams** -The Baseline Protocol has 3 teams, and several focused working groups within each, where anyone can join the bi-weekly meetings and get involved in the efforts by [**signing up**](https://www.baseline-protocol.org/get-involved/)**.** +Baseline has 3 teams, and several focused working groups within each, where anyone can join and get involved in the efforts by [**signing up**](https://www.baseline-protocol.org/get-involved/)**.** > ### Baseline Core Devs > @@ -29,23 +29,23 @@ The Baseline Protocol has 3 teams, and several focused working groups within eac > > ### Outreach Team > -> Outreach members communicate, advocate, and educate the world on the advantages of using and contributing to the protocol. Several working groups create enablement materials, devise industry-specific use cases, and document the significant work being done in the community. +> Outreach members communicate, advocate, and educate the world on the advantages of using and contributing to the protocol. Several working groups create enablement materials, devise industry-specific use cases, and document the significant work being done in the community. The Outreach Team is currently looking for members. > > ### Standards Team > -> Members of the standards team work to define and contribute to the specifications of baseline compliance. The [Standards](broken-reference) is currently in the ratification process to become an official [Oasis Standard](https://www.oasis-open.org). +> Members of the standards team work to define and contribute to the specifications of baseline compliance. The [Standards](https://github.com/ethereum-oasis-op/baseline-standard) are currently in the ratification process to become an official [Oasis Standard](https://www.oasis-open.org). The Standards Team has paused its work. ## Onboarding -Resources are constantly being developed in the community for the effective onboarding of new community members, start by **reviewing the** [**resources**](open-source-community.md#resources) **across the docs here,** [**website**](../docs/baseline-protocol/the-baseline-protocol.md)**, or** [**repository**](https://github.com/orgs/eea-oasis/repositories)**.** +Resources are constantly being developed in the community for the effective onboarding of new community members, start by **reviewing the** [**resources**](open-source-community.md#resources) **across the docs here,** [**website**](../docs/baseline-protocol/the-baseline-protocol.md)**, or** [**repository**](https://github.com/orgs/ethereum-oasis-op/repositories)**.** -Let the community know if there are any gaps you're finding the materials, as we are constantly working to develop valuable tools for implementing, explaining, or evangelizing the Baseline Protocol. +Let the community know if there are any gaps you're finding the materials, as we are constantly working to develop valuable tools for implementing, explaining, or evangelizing Baseline. ## **Leadership** In an openly governed, open source project, leadership is organic. Anyone interested in following the governing policies and leading efforts across the various teams and focuses, can become a prominent leader in the community. -> The way to lead is to start something, help something, fix something...even spellcheck something! The way to lead is to get others to amplify what you are doing (best done by listening deeply to others first). The way to lead is to serve your own (and your company's) enlightened self interest. You should be able to directly draw a straight line from your time on this work to real impact for the adoption of this standard. +> The way to lead is to start something, help something, fix something...even spellcheck something! The way to lead is to get others to amplify what you are doing (best done by listening deeply to others first). The way to lead is to serve your own (and your company's) enlightened self interest. You should be able to directly draw a straight line from your time on this work to real impact for the adoption of this standard. Information on our groups of elected and voluntary community leaders can be [**found here**](community-leaders.md)**.** @@ -57,21 +57,25 @@ Most of our open source teams and workgroups meet bi-weekly to discuss open item #### The Baseline Show -The Baseline Protocol community hosts a weekly[ Baseline Show through Youtube](https://youtube.com/playlist?list=PLxmhMSa49Q1CVwTdcUNeoqoME6GRwtSTA) with various community updates, live demos, guest speakers, themed discussions, and impromptu office hours. Anyone can join the live Zoom call by **emailing baseline-team@oasis-open.org** to be added to the invite. +The Baseline Protocol community used to host a weekly[ Baseline Show through Youtube](https://youtube.com/playlist?list=PLxmhMSa49Q1CVwTdcUNeoqoME6GRwtSTA) with various community updates, live demos, guest speakers, themed discussions, and impromptu office hours. Anyone could join the live Zoom call by **emailing baseline-team@oasis-open.org** to be added to the invite. + +The Baseline Show is currently paused as the community regroups and refocuses. #### General Assembly -The General Assembly is a monthly (typically the first Wednesday) community wide meeting to discuss updates from across the community or adjacent projects. The General Assembly is streamed to the weekly[ **Baseline Show through YouTube**](https://youtube.com/playlist?list=PLxmhMSa49Q1BTD\_-KrpuLIe8P2J1UR19W) and anyone can join the live Zoom call by **emailing baseline-team@oasis-open.org** to be added to the invite. +The General Assembly was a monthly (typically the first Wednesday) community wide meeting to discuss updates from across the community or adjacent projects. The General Assembly was streamed to the weekly[ **Baseline Show through YouTube**](https://youtube.com/playlist?list=PLxmhMSa49Q1BTD\_-KrpuLIe8P2J1UR19W) and anyone could join the live Zoom call by **emailing baseline-team@oasis-open.org** to be added to the invite. + +The General Assembly is currently paused as the community regroups and refocuses. #### Technical Steering Committee -The [**TSC**](community-leaders.md#your-technical-steering-committee) meets 1-2 times a month to discuss open items, review grant work, assess the roadmap, and more. TSC meetings are private to the elected members for that term, although other members can request an invitation to discuss a specific matter by messaging one of the [**TSC Co-Chairs**](../docs/governance/technical-steering-committee.md) on [**Slack**](open-source-community.md#resources). +The [**TSC**](community-leaders.md#your-technical-steering-committee) meets now ad-hoc to discuss open items, review grant work, assess the roadmap, and more. TSC meetings are private to the elected members for that term, although other members can request an invitation to discuss a specific matter by messaging one of the [**TSC Co-Chairs**](../docs/governance/technical-steering-committee.md) on [**Slack**](open-source-community.md#resources). ## Communications #### [Slack](https://join.slack.com/t/ethereum-baseline/shared\_invite/zt-d6emqeci-bjzBsXBqK4D7tBTZ40AEfQ) -The Baseline Protocol Slack channel is the primary communication method for community members, and is moderated by community leaders and managers. The Slack is quite active with ways to get involved, updates, engaging discussions, and questions. Everyone is encouraged to [**join the Slack**](https://join.slack.com/t/ethereum-baseline/shared\_invite/zt-d6emqeci-bjzBsXBqK4D7tBTZ40AEfQ) **** and various channels. +The Baseline Slack channel is the primary communication method for community members, and is moderated by community leaders and managers. The Slack is quite active with ways to get involved, updates, engaging discussions, and questions. Everyone is encouraged to [**join the Slack**](https://join.slack.com/t/ethereum-baseline/shared\_invite/zt-d6emqeci-bjzBsXBqK4D7tBTZ40AEfQ) **** and various channels. #### [Discord](https://discord.gg/NE8AYD7) / Telegram @@ -91,12 +95,14 @@ Anyone [**sign up to the Oasis Baseline Protocol Members list**](https://lists.o The Baseline Protocol community maintains a [**blog** ](https://www.baseline-protocol.org/blog/)for updates from various community members. Anyone can help write blogs or suggest a topic by messaging in the [**#Outreach Slack channel**](https://join.slack.com/t/ethereum-baseline/shared\_invite/zt-d6emqeci-bjzBsXBqK4D7tBTZ40AEfQ) **** or **emailing at baseline-team@oasis-open.org**. -#### [Twitte](https://twitter.com/baselineproto)r / [LinkedIn](https://www.linkedin.com/company/baseline-protocol) +#### [Twitter/X](https://twitter.com/baselineproto)r / [LinkedIn](https://www.linkedin.com/company/baseline-protocol) -The community is actively sharing updates from the open source work or adjacent projects on [**Twitter** ](https://twitter.com/baselineproto)and [**LinkedIn**](https://www.linkedin.com/company/baseline-protocol)**.** +The community is actively sharing updates from the open source work or adjacent projects on [**Twitter/X** ](https://twitter.com/baselineproto)and [**LinkedIn**](https://www.linkedin.com/company/baseline-protocol)**.** #### YouTube -The Baseline Protocol initiative maintains a [**YouTube Channel**](https://www.youtube.com/playlist?list=PLxmhMSa49Q1CVwTdcUNeoqoME6GRwtSTA) **** that includes **** [**weekly streamed community sessions**](open-source-community.md#specifications-steering-committee-1), **** [**monthly general assemblies**](open-source-community.md#specifications-steering-committee-2), appearances of Baseline Protocol members, walkthroughs & demos, and more. Anyone can propose additions to the channel or help create Baseline Protocol video assets by joining the **** [**Outreach Team**](open-source-community.md#teams), messaging in [**Slack**](https://join.slack.com/t/ethereum-baseline/shared\_invite/zt-d6emqeci-bjzBsXBqK4D7tBTZ40AEfQ), or **emailing at baseline-team@oasis-open.org.** +The Baseline initiative maintains a [**YouTube Channel**](https://www.youtube.com/playlist?list=PLxmhMSa49Q1CVwTdcUNeoqoME6GRwtSTA) + +Anyone can propose additions to the channel or help create Baseline video assets by joining the **** [**Outreach Team**](open-source-community.md#teams), messaging in [**Slack**](https://join.slack.com/t/ethereum-baseline/shared\_invite/zt-d6emqeci-bjzBsXBqK4D7tBTZ40AEfQ), or **emailing at baseline-team@oasis-open.org.** ​ diff --git a/docs/README.md b/docs/README.md index 3bd0d461d..ee1f8631f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -16,27 +16,27 @@ The Baseline Protocol is the emerging standard for state synchronization across The Baseline Protocol initiative was [announced](https://consensys.net/blog/press-release/ey-and-consensys-announce-formation-of-baseline-protocol-initiative-to-make-ethereum-mainnet-safe-and-effective-for-enterprises/) on March 4, 2020, and launched as an [OASIS Open Source Project](https://oasis-open-projects.org) on March 19, 2020, supported by fourteen founding companies. More companies joined the effort shortly thereafter and continue to do so. In 2021, the Enterprise Ethereum Alliance and OASIS collaborated to establish the Baseline Protocol as an [EEA Community Project](https://entethalliance.org/eeacommunityprojects/). There are many notable, industry leading, companies sponsoring the Baseline Protocol, [see the list of sponsors](https://www.baseline-protocol.org/become-a-sponsor/) and learn how to become a sponsor and benefits [here](https://www.baseline-protocol.org/become-a-sponsor/). -The work of the community is maintained under a [public domain license](https://github.com/eea-oasis/baseline/blob/main/LICENSE). +The work of the community is maintained under a [public domain license](https://github.com/ethereum-oasis-op/baseline/blob/main/LICENSE). **For new Contributors to the repository and standard, see** [**contribution guidelines here**](community/open-source-community/contributors.md#code-of-conduct)**.** ## The Baseline Protocol Source Code -Version 1.0 of the Baseline Protocol has been released. It is composed of a set of 6 core packages that are open-sourced, under the [CC0 1.0 Universal public domain](https://github.com/eea-oasis/baseline/blob/main/LICENSE) dedication. +Version 1.0 of the Baseline Protocol has been released. It is composed of a set of 6 core packages that are open-sourced, under the [CC0 1.0 Universal public domain](https://github.com/ethereum-oasis-op/baseline/blob/main/LICENSE) dedication. -You can reference the source code **** [**here**](https://github.com/eea-oasis/baseline) and explore information regarding the 6 core packages contained in the docs [**here**](baseline-protocol-code/packages/)**.** +You can reference the source code **** [**here**](https://github.com/ethereum-oasis-op/baseline) and explore information regarding the 6 core packages contained in the docs [**here**](baseline-protocol-code/packages/)**.** ## The Baseline Protocol Standard -The [Baseline Protocol Specifications ](https://github.com/eea-oasis/baseline-standard)were completed in September 2021 and is undergoing ratification to become an [OASIS Open Standard](https://www.oasis-open.org/standards/), available under the [CC0 1.0 Universal public domain](https://github.com/eea-oasis/baseline/blob/main/LICENSE) dedication. +The [Baseline Protocol Specifications ](https://github.com/ethereum-oasis-op/baseline-standard)were completed in September 2021 and is undergoing ratification to become an [OASIS Open Standard](https://www.oasis-open.org/standards/), available under the [CC0 1.0 Universal public domain](https://github.com/ethereum-oasis-op/baseline/blob/main/LICENSE) dedication. -The Baseline Protocol Standard contains three specifications - [CORE](https://github.com/eea-oasis/baseline-standard/tree/main/core), [API](https://github.com/eea-oasis/baseline-standard/tree/main/api), and [CCSM](https://github.com/eea-oasis/baseline-standard/tree/main/ccsm). All three specifications come together to provide the requirements of a standard compliant Baseline Protocol Implementation (BPI). +The Baseline Protocol Standard contains three specifications - [CORE](https://github.com/ethereum-oasis-op/baseline-standard/tree/main/core), [API](https://github.com/ethereum-oasis-op/baseline-standard/tree/main/api), and [CCSM](https://github.com/ethereum-oasis-op/baseline-standard/tree/main/ccsm). All three specifications come together to provide the requirements of a standard compliant Baseline Protocol Implementation (BPI). -**Find full details on the** [**Baseline Protocol Standard here**](https://github.com/eea-oasis/baseline-standard)**.** +**Find full details on the** [**Baseline Protocol Standard here**](https://github.com/ethereum-oasis-op/baseline-standard)**.** ## The Baseline Protocol Reference Implementations -A growing number of [Reference Implementations](bri/overview-of-reference-implementations.md) and demos can be [found here ](https://github.com/ethereum-oasis/baseline/tree/master/examples)to help you understand baselining through example technical implementations. +A growing number of [Reference Implementations](bri/overview-of-reference-implementations.md) and demos can be [found here ](https://github.com/ethereum-oasis-op/baseline/tree/main/examples)to help you understand baselining through example technical implementations. The first complete reference implementation, [**BRI-1**](bri/bri-1/) has been developed by individuals and community leaders including Provide, EY, Nethermind, ConsenSys Mesh, and others. diff --git a/docs/baseline-basics/architecture.md b/docs/baseline-basics/architecture.md index 3c58a924d..50dd3a43a 100644 --- a/docs/baseline-basics/architecture.md +++ b/docs/baseline-basics/architecture.md @@ -10,10 +10,10 @@ Presented below is a reference architecture that ensures two or more systems of **A Baseline Protocol Stack Reference Architecture** as depicted above in Figure 1 is comprised of the following layers: -* **Baseline Protocol Implementation (BPI) Abstraction Layer**: Enables access to externally available BPI functions through APIs as defined in the [Baseline Protocol API Specification](https://github.com/eea-oasis/baseline-standard/tree/main/api). +* **Baseline Protocol Implementation (BPI) Abstraction Layer**: Enables access to externally available BPI functions through APIs as defined in the [Baseline Protocol API Specification](https://github.com/ethereum-oasis-op/baseline-standard/tree/main/api). * **Middleware Layer**: Manages all counterparties to an agreement and its associated workflows and worksteps with business rules and business data, as well as all counterparty delegates. It also manages all messaging between counterparties to an agreement and instantiation of processing layers based on newly created or updated agreements and their workflows, worksteps, business rules, and business data. * **Processing Layer**: Manages, properly sequences, and deterministically processes and finalizes all state change requests from counterparties to all agreements represented in the BPI, in a privacy-preserving, cryptographically verifiable manner . -* **CCSM Abstraction Layer**: Enables access to all required BPI functions implemented on one or more CCSMs through APIs as defined in the [Baseline Protocol API Specification](https://github.com/eea-oasis/baseline-standard/tree/main/api). +* **CCSM Abstraction Layer**: Enables access to all required BPI functions implemented on one or more CCSMs through APIs as defined in the [Baseline Protocol API Specification](https://github.com/ethereum-oasis-op/baseline-standard/tree/main/api). * **CCSM Layer**: Manages, properly sequences, and deterministically processes all transactions from the Processing Layer, as well as either deterministically or probabilistically finalizes all CCSM state transitions based on said transactions on the CCSM. ## Components of Each Layer diff --git a/docs/baseline-basics/faq.md b/docs/baseline-basics/faq.md index 5533aed66..81c6dc8b6 100644 --- a/docs/baseline-basics/faq.md +++ b/docs/baseline-basics/faq.md @@ -4,31 +4,29 @@ description: Frequently Asked Questions # FAQ -## Is there a token for the Baseline Protocol? +## Is there a token for Baseline? -There is no Baseline Protocol token. +There is no Baseline token. -The Baseline Protocol is a standardized framework, with requirements outlined in the [Baseline Protocol Standard](https://github.com/eea-oasis/baseline-standard), which is undergoing ratification to become an [OASIS Open Standard](https://www.oasis-open.org/standards/). +The Baseline Protocol is a standardized framework, with requirements outlined in the [Baseline Protocol Standard](https://github.com/ethereum-oasis-op/baseline-standard), which is undergoing ratification to become an [OASIS Open Standard](https://www.oasis-open.org/standards/). No reference implementations employ a token. Being open-source, open-standard means that anyone is free to build any application or service implementing the protocol. Those applications or services may or may not have their own tokens. -The Baseline Protocol Standard and source code are available under the CC0 1.0 Universal public domain dedication. For the full license text, refer to [license](https://github.com/eea-oasis/baseline/blob/master/LICENSE). +The Baseline Protocol Standard and source code are available under the CC0 1.0 Universal public domain dedication. For the full license text, refer to [license](https://github.com/ethereum-oasis-op/baseline/blob/main/LICENSE). ## I am interested in contributing, where do I start? Join our open source teams - learn more and sign up [here](https://www.baseline-protocol.org/get-involved/). -* _**Baseline Core Devs:** Baseline Core Devs_ are the backbone of the Baseline Protocol open source community and have an active role in advancing the Baseline Protocol and/or related projects. Join the next generation of top blockchain developers leading the rise of ubiquitous sync services to state machines everywhere! +* _**Baseline Maintainers:** Baseline Maintainers_ are the backbone of the Baseline Protocol open source community and have an active role in advancing the Baseline Protocol and/or related projects. Join the next generation of top blockchain developers leading the rise of ubiquitous sync services to state machines everywhere! * **Outreach Team**: Outreach members communicate, advocate, and educate the world on the advantages of using and contributing to the protocol. Several working groups create enablement materials, devise industry-specific use cases, and document the significant work being done in the community. -* **Standards Team**: Members of the team work to define and contribute to the specifications of baseline compliance. The[ Standard ](https://github.com/eea-oasis/baseline-standard)is currently in the ratification process to become an official [Oasis Standard](https://www.oasis-open.org). +* **Standards Team**: Members of the team work to define and contribute to the specifications of baseline compliance. The[ Standard ](https://github.com/ethereum-oasis-op/baseline-standard)is currently in the ratification process to become an official [Oasis Standard](https://www.oasis-open.org). ## I want to build with the Baseline Protocol, where do I start? -**Baseline Protocol v1.0 Core:** If you want to build with the Baseline Protocol from scratch, you can get started with v1.0 core that provides a set of 'vanilla' packages. You can get started [here](../baseline-protocol-code/packages/). - **Reference Implementations:** You can also choose to build on top of existing reference implementations. -We recommend starting with BRI-1, this reference implementation of the core interfaces specified in the v1.0 release has been developed by individuals and companies including Provide, EY, Nethermind, ConsenSys Mesh, and others. It heavily utilizes the core [Provide](https://provide.services) application stack and is compatible with [Shuttle](https://shuttle.provide.services/waitlist), an on-ramp for _baselining_. [NATS](https://nats.io) and the [Nethermind](https://nethermind.io) Ethereum client (the first client to implement the Baseline Protocol RPC) are opinionatedly used by default. You can get started with BRI-1 [here](../bri/bri-1/). +We recommend starting with BRI-3, this reference implementation of the core interfaces specified in the v1.0 release has been developed by individual members of the Baseline community. You can get started with BRI-3 [here](https://github.com/ethereum-oasis-op/baseline/tree/main/examples/bri-3). **Developer Resources:** To help you build with the Baseline Protocol, you can use the implementation guide and other developer resources available [here](../baseline-protocol-code/developer-resources.md). @@ -36,7 +34,7 @@ Join the [Baseline Core Devs](https://www.baseline-protocol.org/get-involved/) o ## My company is interested in baselining, where do I start? -While 'baselining' as a technique is not restricted to commercial use cases, a Baseline Protocol Implementation (BPI) as specified in the[ Baseline Protocol Standard](broken-reference/) requires at least two organizations to come together to synchronize their respective systems of record. +While 'baselining' as a technique is not restricted to commercial use cases, a Baseline Protocol Implementation (BPI) as specified in the [Baseline Protocol Standard](https://github.com/ethereum-oasis-op/baseline-standard) requires at least two organizations to come together to synchronize their respective systems of record. A group of companies interested in 'baselining' can either deploy their own implementation using their in-house resources or they can choose to work with third-party partners (product and service providers). @@ -48,8 +46,8 @@ Any system of record can be baselined without requiring modification to legacy s ## Does 'baselining' require a blockchain? -Distributed Ledger Technology, often referred to as a Consensus Controlled State Machine (CCSM) is the foundational enabler of a Baseline Protocol Implementation (BPI). A compliant BPI requires conformance to the [CCSM specification](../baseline-protocol-standard/ccsm-specification.md) of the [Baseline Protocol Standard](https://github.com/eea-oasis/baseline-standard). +Distributed Ledger Technology, often referred to as a Consensus Controlled State Machine (CCSM) is the foundational enabler of a Baseline Protocol Implementation (BPI). A compliant BPI requires conformance to the [CCSM specification](../baseline-protocol-standard/ccsm-specification.md) of the [Baseline Protocol Standard](https://github.com/ethereum-oasis-op/baseline-standard). ## Does 'baselining' require Ethereum and/or Baseledger ? -While much of the initial work on the Standard and the code was done by companies and individuals in the Ethereum development community, any CCSM that conforms to the [CCSM specification ](../baseline-protocol-standard/ccsm-specification.md)of the[ Baseline Protocol Standard](https://github.com/eea-oasis/baseline-standard) can be used in a compliant Baseline Protocol Implementation (BPI). +While much of the initial work on the Standard and the code was done by companies and individuals in the Ethereum development community, any CCSM that conforms to the [CCSM specification ](../baseline-protocol-standard/ccsm-specification.md)of the[Baseline Protocol Standard](https://github.com/ethereum-oasis-op/baseline-standard) can be used in a compliant Baseline Protocol Implementation (BPI). diff --git a/docs/baseline-basics/the-baseline-protocol.md b/docs/baseline-basics/the-baseline-protocol.md index c8b2882d8..65968ec62 100644 --- a/docs/baseline-basics/the-baseline-protocol.md +++ b/docs/baseline-basics/the-baseline-protocol.md @@ -1,8 +1,16 @@ # Introduction -## What is the Baseline Protocol? +## What is Baseline? -The Baseline Protocol is an open-source initiative that combines advances in cryptography, messaging, and consensus-controlled state machines -- often referred to as blockchains or distributed ledger technology (DLT) -- to deliver secure and private business processes, event ordering, data consistency, and workflow integrity at low cost. The Baseline Protocol provides a framework that allows Baseline Protocol Implementations (BPIs) to establish a common frame of reference, enabling confidential and complex (business) collaborations between enterprises without moving any sensitive data out of traditional Systems of Record. The work is governed as an [EEA Community Project](https://entethalliance.org/eeacommunityprojects/#:\~:text=The%20EEA%20Community%20Projects%2C%20formerly,API%20documentation%20under%20its%20stewardship.), managed by [OASIS](https://oasis-open-projects.org). +The Baseline Protocol is an open-source initiative that combines advances in cryptography, messaging, and consensus-controlled state machines -- often referred to as blockchains or distributed ledger technology (DLT) -- to deliver secure and private business processes, event ordering, data consistency, and workflow integrity at low cost. The Baseline Protocol provides a framework that allows Baseline Protocol Implementations (BPIs) to establish a common frame of reference, enabling confidential and complex (business) collaborations between enterprises without moving any sensitive data out of traditional Systems of Record. The work is governed by [OASIS](https://oasis-open-projects.org). + +The community now focuses on financial inclusion and ESG (Environmental, Social, and Governance) as primary drivers. This pivot is driven by the recognition that the Baseline Protocol can play a crucial role in addressing significant global challenges, such as bridging the SME (Small- and Medium-sizede Enterprise) financing gap in developing regions and promoting sustainable business practices. + +### Rationale for the Pivot + +1. **Financial Inclusion**: The Baseline Protocol Interoperability Demo showcases a use-case with potentially huge economic impact - bridging the SME financing gap in developing regions. By enabling efficient and verifiable data exchange processes, the protocol can help small-scale invoice financing operations attract large debt providers, aggregate fragmented portfolios across jurisdictions, and standardize origination procedures. This can lead to safer and more efficient lending practices, ultimately fostering economic growth and financial inclusion. + +2. **Environmental, Social, and Governance (ESG)**: The community recognizes the importance of ESG factors in modern business practices. By focusing on ESG, the Baseline Protocol can help organizations automate and synchronize business processes in a way that promotes transparency, accountability, and sustainability. This aligns with the growing demand for businesses to adopt responsible practices that benefit society and the environment. ## Why _Baseline_ Different Systems of Record? diff --git a/docs/baseline-protocol-standard/README.md b/docs/baseline-protocol-standard/README.md index d7a329b5c..3c9a219b3 100644 --- a/docs/baseline-protocol-standard/README.md +++ b/docs/baseline-protocol-standard/README.md @@ -2,7 +2,7 @@ The Baseline Protocol Standard will be a set of three specifications - CORE, API and CCSM that together, provide the requirements of a compliant Baseline Protocol Implementation (BPI). -The v1.0 specifications are in draft status by [Oasis](https://www.oasis-open.org) for ratification as an official[ Oasis Standard](https://www.oasis-open.org/standards/), the draft standard is available on Github [here](https://github.com/eea-oasis/baseline-standard). +The v1.0 specifications are in draft status by [Oasis](https://www.oasis-open.org) for ratification as an official[ Oasis Standard](https://www.oasis-open.org/standards/), the draft standard is available on Github [here](https://github.com/ethereum-oasis-op/baseline-standard). ## CORE Specification diff --git a/docs/baseline-protocol-standard/api-specification.md b/docs/baseline-protocol-standard/api-specification.md index 32defcf7f..7c932d7c5 100644 --- a/docs/baseline-protocol-standard/api-specification.md +++ b/docs/baseline-protocol-standard/api-specification.md @@ -1,6 +1,6 @@ # The API Specification -**The API specification document is available on** [**Github here**](https://github.com/eea-oasis/baseline-standard/tree/main/api)**.** +**The API specification document is available on** [**Github here**](https://github.com/ethereum-oasis-op/baseline-standard/tree/main/api)**.** ## API Specification Overview diff --git a/docs/baseline-protocol-standard/ccsm-specification.md b/docs/baseline-protocol-standard/ccsm-specification.md index 0577b91dd..fc102e2b1 100644 --- a/docs/baseline-protocol-standard/ccsm-specification.md +++ b/docs/baseline-protocol-standard/ccsm-specification.md @@ -1,6 +1,6 @@ # The CCSM Specification -**The CCSM specification document is available on Github** [**here**](https://github.com/eea-oasis/baseline-standard/tree/main/ccsm)**.** +**The CCSM specification document is available on Github** [**here**](https://github.com/ethereum-oasis-op/baseline-standard/tree/main/ccsm)**.** ## CCSM Specification Overview diff --git a/docs/baseline-protocol-standard/core-specification.md b/docs/baseline-protocol-standard/core-specification.md index 12bf63df4..efd33588a 100644 --- a/docs/baseline-protocol-standard/core-specification.md +++ b/docs/baseline-protocol-standard/core-specification.md @@ -1,6 +1,6 @@ # The Core Specification -The CORE specification document is available on [Github here](https://github.com/eea-oasis/baseline-standard/tree/main/core). +The CORE specification document is available on [Github here](https://github.com/ethereum-oasis-op/baseline-standard/tree/main/core). ## CORE Specification Overview diff --git a/docs/baseline-protocol/components.md b/docs/baseline-protocol/components.md index 230c91b09..38014fdad 100644 --- a/docs/baseline-protocol/components.md +++ b/docs/baseline-protocol/components.md @@ -63,12 +63,4 @@ The setup of specialized circuits are costly via the time necessary for developm **An Opportunity for Standards and Regulation:** Typically, a small group of counterparties may be fine relying on a code package shared between them to be correct. All they need know is that everyone executed it correctly based on the same inputs, which generated the same outputs. Where greater scrutiny of these packages is needed, consider a set of companies in a highly regulated industry. An industry standards body could publish a set of Circuits/packages/libraries and require their use when regulated companies _baseline_ their Workflows. This would allow the regulated companies, potentially, to reduce the cost of oversight by ensuring the business logic they used to conduct business with their counterparties was done correctly and in accordance with the regulation...or at least with the enforcement Circuits provided. -## UI Integration - -In the Radish34 Demo, the team built a simple web-based UI to simulate the user experience of systems of record that were enabled with the Baseline Protocol. You can find that [**here**](https://github.com/eea-oasis/baseline/tree/v0.1/examples/radish34)**.** - -In the real world, the user experience is the experience of any number of products. - -If you are in charge of the feature/benefit mix of a product in ERP, CRM, SCM, Core Banking or any other type of system of record, you can use the example in the Radish34 UI section to get ideas for how to integrate with baseline components (whether they have added to your product's internal services or whether they have been deployed as services in your wider IT environment) and present baselining benefits to users. - ​ diff --git a/docs/baseline-protocol/layer-2-scaling-and-bridges.md b/docs/baseline-protocol/layer-2-scaling-and-bridges.md deleted file mode 100644 index f7d784cb3..000000000 --- a/docs/baseline-protocol/layer-2-scaling-and-bridges.md +++ /dev/null @@ -1,89 +0,0 @@ -# Layer 2 Scaling - -This document outlays an approach to bridging considerations for committing baseline proofs managed across workgoups to the mainnet. - -## Motivation - -1. Baseline proof verification on the mainnet is a gas intensive process owing to the complexity in computing the verification against the pairing library. -2. Furthermore, there is an added cost of gas to verify the set membership of the document hash in the Shield contract on the mainnet. -3. Enterprises typically have over millions of internal processes, that would be baselined, and it is not feasible to verify every baseline proof on the mainnet. -4. Transactions on the mainnet have intrinsic economic value to indicate the processes' value, transactability/transferability and prevent double spending. -5. While individual baseline proofs need not necessarily have 1:1 correspondence on the mainnet, they can still be represented as a composite transaction on the mainnet. - -## Path to Scaling - -To scale baseline protocol across multiple participants on the mainnet, there are several criteria to be considered: - -* Usability: Ease of use/access to baseline proofs for a given organization and a given process/workflow step. -* Throughput: Ability to process or record a high volume of steps. -* Finality: Finality of the transaction on the mainnet. -* Security: Usage of privacy and hiding of critical data. -* Decentralization: Degree to which the steps need to be validated by a wide variety of participants. -* Updates: Ability to update existing steps in view of changes to an organization's internal processes. - -Rank ordering, with "Crucial" indicating absolutely necessary criterion and "Important" indicating essential but not a driving consideration for baselining enterprise systems, below is a scalability matrix of the above criteria: - -| Criterion | Crucial | Important | -| ---------------- | ------- | --------- | -| Usability | | Y | -| Throughput | Y | | -| Finality | Y | | -| Security | Y | | -| Decentralization | | Y | -| Updates | Y | | - -### Why Bridging? - -1. Problem of workgroup interaction scales with a complexity of O(n^2). -2. Workgroup identification and tracking membership is local to each "workgroup" instance. -3. Scaling concerns grow with addition of L2's and proving membership in a particular network. Any L2 protocol basis for running baseline workgroups away from the mainnet have membership concerns. - -![Workgroup Challenges](../assets/bridging/baseline-arch-workgroup-challenges.png) - -### Bridging Considerations - -1. Any local step of a workgroup can be "materialized" into a token transaction on the mainnet. -2. Determine exit or trigger conditions for exiting a process -3. Upload a "composite" proof to be used by all workgroups to a Merkle Tree Set on the mainnet. -4. Anchor signatures and timestamp deltas for offchain consensus, as inputs to a wrapped rollup (R1CS) circuit. -5. Verify wrapped proof contents and transfer token from one workgroup to another (tied to verifying entry criteria for the target workgroup) - -![Bridging Workflow](../assets/bridging/baseline-arch-bridging-workflow.png) - -## Bridging Design & Implementation Considerations - -### Transition of Membership - -* Involves setting up a registration and de-registration mechanism (under constraints of privacy), using “commitments” and “nullifiers”. -* Proving membership in a workgroup by computing new roots and leaves of the Merkle tree, aka “committing” a state(IBaselineRPC.track()). -* Update/Delete of state corresponds to re-computing the roots and leaves, aka “re-committing” and “nullifying” a state(IBaselineRPC.getTracked(), verify()) - -### Registration and De-registration - -* Nullifiers are typically used in the context of “spending” commitments. To nullify is to reveal or “exit” out of a state of commitment (IBaselineRPC.trackNullifier()\*\*) Example: Terms have been met, payment can be issued -* Nullifiers managed as a tracker of shield contract, which in of itself is a separate Merkle tree represents verified de-registration (IBaselineRPC.getTrackedNullifier()\*\*, verify()) - -![Brigding Workflow Design](../assets/bridging/baseline-arch-bridging-workflow-design.png) - -## Key Takeaways - -1. Layer 2 protocols can be used to scale baseline proofs and leverage recursive proof generations to compose/batch baseline proofs. -2. The composition depicted in the above design assumes a simpler protocol proof, that is common to any baseline participant to verify BLS signatures of workgroup proofs. -3. Each of the workgroup proofs are created with R1CS circuits, custom and specific to the particular workgroup. -4. The workgroup proof itself is a composition of proofs and the above scheme depicts a simple zk-rollup proof, leveraging gnark as the privacy provider. -5. Using standardized interfaces for Shield and RShield to represent accumulators of commitments and nullifiers, cross chain state can be synchronized to the mainnet. -6. Synchronization to the mainnet, is pre-supposed on the exit condition of signed proofs and can be represented as a trigger for minting token to the mainnet participants. -7. Verifier interface on the mainnet can be defined based on the type of composition and pairing elliptic curve configured for zk-rollup. - -## Future Directions - -1. Overall baseline protocol proof can be extended to be a multi-sign verification R!CS circuit. -2. Composition scheme can be extended or generalized to work with zk-zkrollups and plonk rollup schemes within the context of enabling privacy using zk-snarks. -3. Extensions to use other zkp techniques such as zk-starks, bulletproofs, etc. -4. Using bilinear accumulators in place of Merkle trees for set membership proofs. - -## Contributors - -1. Kartheek Solipuram (@skarred14) -2. Kyle Thomas (@kthomas) -3. Lucas Rodriguez (@LucasRodriguez) diff --git a/docs/baseline-protocol/the-baseline-protocol.md b/docs/baseline-protocol/the-baseline-protocol.md index be6b42eb4..2e1aff22d 100644 --- a/docs/baseline-protocol/the-baseline-protocol.md +++ b/docs/baseline-protocol/the-baseline-protocol.md @@ -1,8 +1,8 @@ -# The Baseline Protocol +# Baseline and its Protocol -The Baseline Protocol is an open source initiative that combines advances in cryptography, messaging, and blockchain to deliver secure and private business processes at low cost using the public Mainnet for event ordering, data consistency and workflow integrity. The protocol will enable confidential and complex collaboration between enterprises without moving any sensitive data from traditional systems of record. The work is governed as an [EEA Community Project](https://entethalliance.org/eeacommunityprojects/), managed by [OASIS](https://oasis-open-projects.org). +Baseline and its Protocol is an open source initiative that combines advances in cryptography, messaging, and blockchain to deliver secure and private business processes at low cost using the public Mainnet for event ordering, data consistency and workflow integrity. The protocol will enable confidential and complex collaboration between enterprises without moving any sensitive data from traditional systems of record. The work is governed by [OASIS](https://oasis-open-projects.org). -**The source code can be found** [**here**](https://github.com/eea-oasis/baseline/tree/main)**.** +**The source code can be found** [**here**](https://github.com/ethereum-oasis-op/baseline/)**.** ## Why _Baseline_ Different Systems of Record? @@ -16,7 +16,7 @@ The high level description and specification for a global public Mainnet are [he The Baseline Protocol can perform its core tasks on the current public Ethereum network at a rate that is reasonably expected to be sufficient for work in supply chain, B2B contracting, CRM, and other domains that involve coordinating records between legally separate entities. -Eth2 will further extend the range of applications that baselining can serve at acceptable levels of performance and reliability. The Baseline Protocol community will align closely with Eth2 and work through the EEA Mainnet Working Group to supply the Ethereum core developer community with ideas, user stories and requirements to help see Eth2 evolve into a platform well-suited to baselining. +Eth2 will further extend the range of applications that baselining can serve at acceptable levels of performance and reliability. The Baseline Protocol community will align closely with Ethereum and work through the EEA and the Ethereum Foundation to supply the Ethereum maintainer community with ideas, user stories and requirements to help see Eth2 evolve into a platform well-suited to baselining. ## Which Systems of Record Can We _Baseline?_ @@ -26,4 +26,4 @@ Any state machine should be able to support the "baseline" pattern. Permissioned ## Current State of the Baseline Protocol -The Baseline Core Version 1.0 has been ratified by the Technical Steering Committee on the 30th of September 2021 via unanimous vote on a recorded meeting. The standard draft has been submitted to OASIS for ratification to a standard. The submitted version of the document may be found [**here**](https://github.com/eea-oasis/baseline-standard/blob/main/core/baseline-core-v1.0-psd01.md) and the issue related to the approval of the standard may be found [**here**](https://github.com/eea-oasis/baseline-standard/issues/77#issue-1012249365). +The Baseline Core Version 1.0 has been ratified by the Technical Steering Committee on the 30th of September 2021 via unanimous vote on a recorded meeting. The standard draft has been submitted to OASIS for ratification to a standard. The submitted version of the document may be found [**here**](https://github.com/ethereum-oasis-op/baseline-standard). diff --git a/docs/community/community-leaders/README.md b/docs/community/community-leaders/README.md index e395aba11..09883706b 100644 --- a/docs/community/community-leaders/README.md +++ b/docs/community/community-leaders/README.md @@ -25,7 +25,7 @@ The Technical Steering Committee (TSC) is accountable to the [Project Governance The group is responsible for reviewing and approving proper use of the grant funds, to ensure funds are allocated to valuable and appropriate work. The TSC meets regularly to set technical roadmaps and ensure progress of the community toward the ubiquitous implementation of the Baseline Protocol. -The list of members for the TSC for the period from November 2022 to November 2023 can be [**found here**](https://github.com/eea-oasis/baseline/blob/main/TECHNICAL-STEERING-COMMITTEE.md). +The list of members for the TSC for the period from November 2022 to November 2023 can be [**found here**](https://github.com/ethereum-oasis-op/baseline/blob/main/TECHNICAL-STEERING-COMMITTEE.md). ## Standards Team diff --git a/docs/community/community-leaders/maintainers.md b/docs/community/community-leaders/maintainers.md index 9037a0396..11cf2ff3f 100644 --- a/docs/community/community-leaders/maintainers.md +++ b/docs/community/community-leaders/maintainers.md @@ -10,7 +10,7 @@ description: >- Anyone is welcome to join the Baseline Core Developers to develop technical advancements or even just engage in technical discussions that take place. -### How to become a Baseline Core Developer? +### How to become a Baseline Maintainer? Sign up to join the Baseline Core Developers[ **here**](https://www.baseline-protocol.org/get-involved/) \*\*\*\* to receive the calendar invites and access to the Google Drive resources. @@ -18,9 +18,9 @@ Sign up to join the Baseline Core Developers[ **here**](https://www.baseline-pro Core developers are people who take an active role in advancing the Baseline Protocol and/or related projects. They are primarily responsible for: -* Submitting or working on [**Baseline Improvement Proposals (BLIPs)** ](https://github.com/eea-oasis/baseline-blips)\*\*\*\* +* Submitting or working on [**Baseline Improvement Proposals (BLIPs)** ](https://github.com/ethereum-oasis-op/baseline-blips)\*\*\*\* * Contributing code or contributing to specification work in the form of PRs that are linked to open and prioritized issues -* Developing items on the [**Baseline Protocol Roadmap** ](https://github.com/eea-oasis/baseline/blob/main/Baseline%20Protocol%20-%202022%20Roadmap.pdf)to achieve high priority items +* Developing items on the [**Baseline Protocol Roadmap** ](https://github.com/ethereum-oasis-op/baseline/blob/main/Baseline%20Protocol%20-%202022%20Roadmap.pdf)to achieve high priority items * Setting up and supporting infrastructure (running demos, CI systems, community projects, etc.) that further the Baseline Protocol * Presenting the project and key technologies to the public (in-person, webinar, videos, articles, etc.) * Identify technical resources needed for further implementation of the protocol (developer onboarding materials, tutorials, etc.) @@ -32,11 +32,11 @@ Baseline Protocol Maintainers are Baseline Core Developers with advanced Github ### How to become a Baseline Maintainer? -A Baseline Core Developer can become a Baseline Maintainer by doing the following, +A Baseline Maintainer can become a Baseline Maintainer by doing the following, -* Being an active Baseline Core Developer by actively attending the bi-weekly meetings -* Making a contribution to the Baseline Protocol through [**BLIP work**](https://github.com/eea-oasis/baseline-blips), [**progressing the roadmap**](https://github.com/eea-oasis/baseline/blob/main/Baseline%20Protocol%20-%202022%20Roadmap.pdf), or other efforts -* Then completing the [**Pull\_Request\_Template** ](https://github.com/eea-oasis/baseline/blob/main/.github/PULL\_REQUEST\_TEMPLATE.md)in its entirety to add users Github ID to the [**Code Owners file**](https://github.com/eea-oasis/baseline/blob/main/.github/CODEOWNERS) +* Being an active Baseline Maintainer by actively attending the bi-weekly meetings +* Making a contribution to the Baseline Protocol through [**BLIP work**](https://github.com/ethereum-oasis-op/baseline-blips), [**progressing the roadmap**](https://github.com/ethereum-oasis-op/baseline/blob/main/Baseline%20Protocol%20-%202022%20Roadmap.pdf), or other efforts +* Then completing the [**Pull\_Request\_Template** ](https://github.com/ethereum-oasis-op/baseline/blob/main/.github/PULL\_REQUEST\_TEMPLATE.md)in its entirety to add users Github ID to the [**Code Owners file**](https://github.com/ethereum-oasis-op/baseline/blob/main/.github/CODEOWNERS) * The current Maintainers (listed Code Owners) will be assigned to review the Pull Request, and the PR will be merged once **two** Maintainers approve the request * If the Baseline Maintainer request is denied or poses concerns, the proposer or other Baseline Core Devs can escalate to the TSC @@ -44,8 +44,8 @@ A Baseline Core Developer can become a Baseline Maintainer by doing the followin To retain Maintainer permissions and status, Baseline Maintainers are required to comply with the following, -* **Attendance Policy:** Maintainers must notify the [**'maintainer' Slack**](https://join.slack.com/t/ethereum-baseline/shared\_invite/zt-d6emqeci-bjzBsXBqK4D7tBTZ40AEfQ) group or a community leader if unable to attend. If a Maintainer misses **three** consecutive meetings without prior notice, a community member will submit a PR to remove the member's GitHub ID from the [**Code Owners File**](https://github.com/eea-oasis/baseline/blob/main/.github/CODEOWNERS) -* **If a Maintainer is removed due to the attendance policy**, they must attend 2 Core Dev sessions, notify the group of intent to re-commit, then submit the PR to be added back to the [**Code Owners File**](https://github.com/eea-oasis/baseline/blob/main/.github/CODEOWNERS). +* **Attendance Policy:** Maintainers must notify the [**'maintainer' Slack**](https://join.slack.com/t/ethereum-baseline/shared\_invite/zt-d6emqeci-bjzBsXBqK4D7tBTZ40AEfQ) group or a community leader if unable to attend. If a Maintainer misses **three** consecutive meetings without prior notice, a community member will submit a PR to remove the member's GitHub ID from the [**Code Owners File**](https://github.com/ethereum-oasis-op/baseline/blob/main/.github/CODEOWNERS) +* **If a Maintainer is removed due to the attendance policy**, they must attend 2 Core Dev sessions, notify the group of intent to re-commit, then submit the PR to be added back to the [**Code Owners File**](https://github.com/ethereum-oasis-op/baseline/blob/main/.github/CODEOWNERS). * Show commitment over time by timely review of Pull Requests * Follow branch, PR, code, project style, and testing guidelines * Be reliable in completing issues to which they have been assigned @@ -54,9 +54,9 @@ To retain Maintainer permissions and status, Baseline Maintainers are required t * Be welcoming to others in the community who are using or interested in the protocol * Contribute in ways that substantially improve the quality of the project and the experience of people who use it -## How to stop being a Baseline Core Developer or Maintainer? +## How to stop being a Baseline Maintainer or Maintainer? -To step away from being a Baseline Core Developer, you can notify the other core developers you would like to relinquish your core developer status. +To step away from being a Baseline Maintainer, you can notify the other core developers you would like to relinquish your maintainer status. What can take away your Core Dev status? @@ -64,7 +64,7 @@ What can take away your Core Dev status? * You are disrespectful towards anyone in the community and/or involved in the project. * You are disruptive to the general process of maintaining the project, meetings, discussions, issues, or other. -Two-thirds of all current Maintainers constitute a quorum for a meeting involving a question of removal. A simple majority vote from Maintainers is required to remove a Baseline Core Dev, but the TSC may be brought in to arbitrate if the Baseline Core Developer to be removed or any other Baseline Core Developer wishes to dispute the action. See [**Governance**](../../governance/governance.md#charter-baseline-open-source-project-governance) \*\*\*\* for details. +Two-thirds of all current Maintainers constitute a quorum for a meeting involving a question of removal. A simple majority vote from Maintainers is required to remove a Baseline Core Dev, but the TSC may be brought in to arbitrate if the Baseline Maintainer to be removed or any other Baseline Maintainer wishes to dispute the action. See [**Governance**](../../governance/governance.md#charter-baseline-open-source-project-governance) \*\*\*\* for details. ## How do Baseline Core Developers organize? @@ -74,8 +74,8 @@ The Baseline Core Developers talk in the [**'05-bl-core-devs' channel in Slack** The Baseline Maintainers use a private 'maintainers' channel in Slack that members with Maintainer status are added to. -### Baseline Core Developer Meetings +### Baseline Maintainer Meetings -There are bi-weekly Baseline Core Developer _meetings_ where members can new or open [**Baseline Improvement Proposals (BLIPs)**](https://github.com/eea-oasis/baseline-blips), open repo issues and pull requests, roadmap items grant projects, and more. +There are bi-weekly Baseline Maintainer _meetings_ where members can new or open [**Baseline Improvement Proposals (BLIPs)**](https://github.com/ethereum-oasis-op/baseline-blips), open repo issues and pull requests, roadmap items grant projects, and more. -Members with Maintainer status are required to join Baseline Core Developer meetings, as outlined in the terms above. +Members with Maintainer status are required to join Baseline Maintainer meetings, as outlined in the terms above. diff --git a/docs/community/governance.md b/docs/community/governance.md index 5bd867f63..5dd925264 100644 --- a/docs/community/governance.md +++ b/docs/community/governance.md @@ -4,19 +4,19 @@ OASIS Open is a non-profit, vendor-neutral standards developing organization. It provides rules and guidelines to ensure equitable and transparent oversight of technical collaborations in open source and open standards. Additionally, it provides services such as technical program support, legal, marketing, and events management. -The Baseline Protocol is governed by the [EEA Community Projects Project Governing Board (PGB)](https://github.com/eea-oasis/managed-open-project/blob/main/PROJECT-GOVERNING-BOARD.md) under the [OASIS Open Projects Program](http://oasis-open-projects.org/). EEA Community Projects exists to provide a neutral forum for companies and community representatives to create high-quality specifications that facilitate Ethereum’s longevity, interoperability, and ease of integration. One does not have to "join" the group formally or financially in order to make a contribution to Baseline or other Ethereum OASIS projects. +The Baseline Protocol is governed by the [Ethereum OASIS Projects Project Governing Board (PGB)](https://github.com/ethereum-oasis-op/managed-open-project/blob/main/PROJECT-GOVERNING-BOARD.md) under the [OASIS Open Projects Program](http://oasis-open-projects.org/). EEA Community Projects exists to provide a neutral forum for companies and community representatives to create high-quality specifications that facilitate Ethereum’s longevity, interoperability, and ease of integration. One does not have to "join" the group formally or financially in order to make a contribution to Baseline or other Ethereum OASIS projects. Additional documentation about the OASIS Open Projects program can be found [here](https://github.com/oasis-open-projects/documentation). ## License and Patent Policies -All repos in the EEA Community Projects organization, including Baseline Protocol repositories, adhere to OASIS Open Projects [license](https://github.com/oasis-open-projects/documentation/blob/master/policy/licenses.md) and [patent polices](https://github.com/oasis-open-projects/documentation/blob/master/policy/call-for-patent-disclosure.md). +All repos in the Ethereum OASIS Projects organization, including Baseline Protocol repositories, adhere to OASIS Open Projects [license](https://github.com/oasis-open-projects/documentation/blob/main/policy/licenses.md) and [patent polices](https://github.com/oasis-open-projects/documentation/blob/main/policy/call-for-patent-disclosure.md). -In order to ensure clean IPR that allows Baseline to remain an open technology, OASIS rules require an [Entity CLA](https://www.oasis-open.org/open-projects/cla/entity-cla-20210630/) for persons or organizations contributing on behalf of a legal entity, and an [Individual CLA](https://cla-assistant.io/eea-oasis/managed-open-project) for community contributions. You must [sign the ICLA](https://cla-assistant.io/eea-oasis/managed-open-project) before your pull requests to the baseline repository will be merged. [Check here](https://community.oasis-open.org/s/searchdirectory?id=a233l0000038IIo) to see if your company has signed the ECLA. +In order to ensure clean IPR that allows Baseline to remain an open technology, OASIS rules require an [Entity CLA](https://www.oasis-open.org/open-projects/cla/entity-cla-20210630/) for persons or organizations contributing on behalf of a legal entity, and an [Individual CLA](https://cla-assistant.io/ethereum-oasis-op/managed-open-project) for community contributions. You must [sign the ICLA](https://cla-assistant.io/ethereum-oasis-op/managed-open-project) before your pull requests to the baseline repository will be merged. [Check here](https://community.oasis-open.org/s/searchdirectory?id=a233l0000038IIo) to see if your company has signed the ECLA. ## Code of Conduct -​Here is the link to the official [code of conduct](https://github.com/eea-oasis/baseline/blob/master/CODE_OF_CONDUCT.md). +​Here is the link to the official [code of conduct](https://github.com/ethereum-oasis-op/baseline/blob/main/CODE_OF_CONDUCT.md). ## **Charter: Baseline Open Source Project Governance** @@ -64,9 +64,9 @@ The TSC shall determine the number of maintainers required to merge a contributi This document shall be ratified by the PGB before the public launch of the Baseline Protocol. Changes to this document shall require a simple majority of the PGB. -### Details on OASIS and EEA Community Projects +### Details on OASIS and Ethereum OASIS Projects -Governance documents for [EEA Community Projects](https://github.com/eea-oasis/managed-open-project/blob/main/GOVERNANCE.md). +Governance documents for [Ethereum OASIS Projects](https://github.com/ethereum-oasis-op/managed-open-project/blob/main/GOVERNANCE.md). ### TSC Rules for Mid-term Member Replacements diff --git a/docs/community/open-source-community/README.md b/docs/community/open-source-community/README.md index cd690318e..1056c70cb 100644 --- a/docs/community/open-source-community/README.md +++ b/docs/community/open-source-community/README.md @@ -30,7 +30,7 @@ Outreach members communicate, advocate, and educate the world on the advantages ### **Standards Team** -Members of the standards team work to define and contribute to the specifications of baseline compliance. The [Standard](https://github.com/eea-oasis/baseline-standard) is currently in the ratification process to become an official [Oasis Standard](https://www.oasis-open.org). +Members of the standards team work to define and contribute to the specifications of baseline compliance. The [Standard](https://github.com/ethereum-oasis-op/baseline-standard) is currently in the ratification process to become an official [Oasis Standard](https://www.oasis-open.org). ## Meetings and Meetups diff --git a/docs/community/open-source-community/contributors.md b/docs/community/open-source-community/contributors.md index 45358e082..bba996e57 100644 --- a/docs/community/open-source-community/contributors.md +++ b/docs/community/open-source-community/contributors.md @@ -6,9 +6,9 @@ description: >- # Contributing -All work of the Baseline Protocol initiative is maintained publicly on a [**Github repository.**](https://github.com/eea-oasis/baseline) +All work of the Baseline Protocol initiative is maintained publicly on a [**Github repository.**](https://github.com/ethereum-oasis-op/baseline) -Full governance for contributing can be[ **found here.** ](https://github.com/eea-oasis/baseline/blob/main/CONTRIBUTING.md)**** +Full governance for contributing can be[ **found here.** ](https://github.com/ethereum-oasis-op/baseline/blob/main/CONTRIBUTING.md)**** Anyone with a Github ID can fork the repo, submit an issue, submit a PR, or participate in the further development of the work. @@ -24,7 +24,7 @@ There is one other, important, way to contribute: **use the work in the Baseline The Baseline Protocol Code of Conduct is located here -{% embed url="https://github.com/ethereum-oasis/baseline/blob/master/CODE_OF_CONDUCT.md" %} +{% embed url="https://github.com/ethereum-oasis-op/baseline/blob/main/CODE_OF_CONDUCT.md" %} ## Technical Contributors @@ -32,7 +32,7 @@ Technical contributors are the[ **Technical Members**](../community-leaders/main ### BLIPs -As of October 1, 2021, the Baseline Protocol organizes using[ **Baseline Improvement Proposals (BLIPs)**](https://github.com/eea-oasis/baseline-blips), which are managed similarly to [**Ethereum Improvement Proposals (EIPs)**](https://eips.ethereum.org/)**.** Everyone is encouraged to submit a BLIP for an idea related to the further development or enhancement of the protocol. BLIPs can be worked on by the Baseline Core Developers or anyone interested, and even be funded through the[ **grant fund**](https://github.com/eea-oasis/baseline-grants) if requested and approved. +As of October 1, 2021, the Baseline Protocol organizes using[ **Baseline Improvement Proposals (BLIPs)**](https://github.com/ethereum-oasis-op/baseline-blips), which are managed similarly to [**Ethereum Improvement Proposals (EIPs)**](https://eips.ethereum.org/)**.** Everyone is encouraged to submit a BLIP for an idea related to the further development or enhancement of the protocol. BLIPs can be worked on by the Baseline Core Developers or anyone interested, and even be funded through the[ **grant fund**](https://github.com/ethereum-oasis-op/baseline-grants) if requested and approved. ### Work Item Management @@ -53,7 +53,7 @@ Good practice strongly favors committing work frequently to allow Baseline Maint Anyone can submit a pull request and commit work to the community. In order for your work to be merged, you will need to sign the eCLA (entity contributor agreement) or iCLA (individual contributor agreement). Here are the details: [https://www.oasis-open.org/resources/projects/cla/projects-entity-cla](https://www.oasis-open.org/resources/projects/cla/projects-entity-cla)​ -The iCLA happens automatically when people submit a pull request, or they can access directly by going to [https://cla-assistant.io/ethereum-oasis/baseline](https://cla-assistant.io/ethereum-oasis/baseline)​ +The iCLA happens automatically when people submit a pull request, or they can access directly by going to [https://cla-assistant.io/ethereum-oasis-op/baseline](https://cla-assistant.io/ethereum-oasis-op/baseline)​ ### Core Developers and Commit Rules @@ -65,6 +65,6 @@ All contributors to the Baseline repositories that have a merged pull request an ## ​Contributors -The active contributors and maintainers of the Baseline Protocol repo can be found on [Github](https://github.com/ethereum-oasis/baseline/graphs/contributors). +The active contributors and maintainers of the Baseline Protocol repo can be found on [Github](https://github.com/ethereum-oasis-op/baseline/graphs/contributors). Note: many contributors work in clones extending the protocol for their products. These people don't necessarily show up in the Github contributors list. diff --git a/docs/connectors/erp-connector-google-sheets-microsoft-dynamics.md b/docs/connectors/erp-connector-google-sheets-microsoft-dynamics.md deleted file mode 100644 index a15db20ca..000000000 --- a/docs/connectors/erp-connector-google-sheets-microsoft-dynamics.md +++ /dev/null @@ -1,88 +0,0 @@ -# Google Sheets/Microsoft Dynamics - -**⚠️ The "Baseline Microsoft Dynamics and Google Sheets" initiative is being integrated with** [**this new reference implementation**](../../) **as a result of the `v0.1` release.** - -## Baselining Business Process Automation across SAP and Microsoft Dynamics - -**George Spasov (Limechain), Vlad Ivanov (Limechain), Kyle Thomas (Provide)** - -May 21, 2020 - -## Introduction - -The "Baseline Mycrosoft Dynamics and Google Sheets" shows establishing a common frame of reference on the public Ethereum Mainnet between Mycrosoft Dynamics and Google Sheets. The demo extends the [Radish34 POC](../deprecated-work/radish34/radish34-explained.md), showing a procurement process in a supply chain POC. - -The open-source-available code of the development work continues the positive trend of Baseline demos showcasing the connection between two system with quite different level of sophistication. - -## What is Baseline? - -The Baseline Protocol is an approach to using the public Mainnet as a common frame of reference between systems, including traditional corporate systems of record, any kind of database or state machine, and even different blockchains or DLTs. It is particularly promising as a way to reduce capital expense and other overheads while increasing operational integrity when automating business processes across multiple companies. - -The approach is designed to appeal to security and performance-minded technology officers. - -You can find all the details on the Baseline Protocol [here](../baseline-protocol/the-baseline-protocol.md). - -## Challenges and Scope of Work - -Continuing the work from the SAP and D365 demo, this demo aims to showcase that two seemingly different in level of sophistication systems, can be kept in sync through the concept of baseline. This is required as more than 30% of the vendors of the big enterprises are small niche vendors lacking the resources and need to integrate a sophisticated system. - -The Use-case shown in the demo follows this path: - -#### Intro - -* Julia is the supply manager in the "USMF - Contoso Entertainment System USA". She deals with finding and working with suppliers. Contoso uses Microsoft Dynamics 365 to manage all its operations. -* Todd is the owner of the small niche HDMI manufacturing plant called ACME. Todd is quite happy to manage his plant via good old Google Spreadsheet. -* Julia is in need of HDMI cables and has found Todd. -* This demo will show how "Baseline" can help Julia and Todd's records stay in sync despite Todd not using a sophisticated system. - -#### RFQ - -* Through the Dynamics Finance and Operations module Julia creates a Request for Quotation. -* She specifies the HDMI cables that she needs and adds delivery details. -* Then she specifies that ACME should receive this request and sends it. -* In a minute Todd sees his spreadsheet populated with the latest request from Julia. - -#### Proposal - -* Todd reviews the request and decides to send a formal proposal to Julia. He enters the proposal data. -* Through Google Sheets add-on he connects to his baseline service and sends the proposal back to Julia. -* In a minute Julia receives the offer from Todd. - -#### Contract - -* As Julia is happy with Todds proposal, she accepts it and proceeds to create an agreement out of Todds proposal. -* In a minute, Todd receives the agreement data in his spreadsheet through his baseline service. - -#### Purchase order - -* With the agreement in place, Julia decides to buy some items from Todd. -* Through the Purchase Orders module in Dynamics 365 she creates a new Purchase order and specifies the items and quantities she needs. -* She confirms the purchase order and sends it to Todd. -* In a minute, Todd receives the purchase order in his spreadsheet through his baseline service. - -The proposed architecture and solutions to these challenges are presented in the next sections. - -## Architecture Proposal - - The diagram above outlines the major architectural components. The following sections will give you an more in-depth overview of these components. - -![](../../examples/bri-1/lib/google-sheets-connector/images/sequence-diagram.png) - -* Julia D365 - The Microsoft Dynamics ERP environment of Julia -* Julia Provide Shuttle - The Baseline service of Julia -* Ethereum mainnet - The ethereum mainnet and the Baseline Smart Contracts needed -* Todds Provide Shuttle - The Baseline service of Todd -* Todds Worker Google Cloud Functions - Cloud functions that synchronize Todds spreadsheet with Todds Shuttle regularly -* Todds Google Spreadsheet with Sheets Baseline Add-on - Google Spreadsheet with installed Sheets Add-on written in apps script - -### Microsoft Dynamics ERP - -The Microsoft Dynamics ERP component is extension code written that connects to the Provide shuttle environments. It is written in X++ - the native language for Dynamics. It translates the native Dynamics objects to the ones required by the Baseline Service. Also regularly polls the Baseline service for news coming from the network. - -![Microsoft Dynamics](../../examples/bri-1/lib/google-sheets-connector/images/dynamics.png) - -### Google Sheets - -The google sheets side is a regular google spreadsheet with an Baseline Add-on installed. Regular repeating cloud tasks are polling new info from the Baseline service and insert it in the correct tables. In addition through the Add-on Todd is able to connect and send data to his Baseline Service. - -![Google Sheets](../../examples/bri-1/lib/google-sheets-connector/images/sheets.png) diff --git a/docs/connectors/erp-connector-sap-microsoft-dynamics.md b/docs/connectors/erp-connector-sap-microsoft-dynamics.md deleted file mode 100644 index 6a1867a76..000000000 --- a/docs/connectors/erp-connector-sap-microsoft-dynamics.md +++ /dev/null @@ -1,164 +0,0 @@ -# SAP/Microsoft Dynamics - -**⚠️ The "Baseline-SAP-Dynamics" ERP connector codebase is being integrated with** [**this new reference implementation**](../bri/bri-1/) **as a result of the `v0.1` release.** - -## Baselining Business Process Automation across SAP and Microsoft Dynamics - -**Stefan Schmidt (Unibright), Kyle Thomas (Provide), Daniel Norkin (Envision Blockchain)**\ -May 21, 2020 - -## Introduction - -The "Baseline-SAP-Dynamics Demo" shows a setup of different Enterprise Resource Planning Systems ("ERPs") using the Baseline Protocol to establish a common frame of reference on the public Ethereum Mainnet. The demo extends the [Radish34 POC](../deprecated-work/radish34/radish34-explained.md), showing a procurement process in a supply chain POC. - -The open-source-available code of the development work on this demo evolved out of a Hackathon of the EEA Eminent Integration Taskforce members Unibright and Provide and is being made available alongside the Radish34 example. - -## What is Baseline? - -The Baseline Protocol is an approach to using the public Mainnet as a common frame of reference between systems, including traditional corporate systems of record, any kind of database or state machine, and even different blockchains or DLTs. It is particularly promising as a way to reduce capital expense and other overheads while increasing operational integrity when automating business processes across multiple companies. - -The approach is designed to appeal to security and performance-minded technology officers. - -You can find all the details on the Baseline Protocol [here](../baseline-protocol/the-baseline-protocol.md). - -## Challenges and Scope of Work - -The setting of tasks in the Community Bootstrapping Phase of Baseline [roadmap](../baseline-protocol/the-baseline-protocol.md) include extraction of concepts out of the Radish34 demo case into the protocol level. This demo therefore wants to extend the Radish34 case by integrating off-chain systems of record, to work out major challenges and provide solutions to them. The learnings should be manifested in a reference implementation that can support standards on the protocol itself. - -The Use-case shown in the demo follows this path: - -* A buyer, using SAP ERP, creates a Request For Proposal and sends it out to 2 of his potential suppliers -* One supplier, using a Microsoft Dynamics D365 ERP, receives the Request For Proposal, turning it into a Proposal with different price tiers, and sending it back to the buyer -* The buyer receives this Proposal, runs a comparison logic between different received proposals (including those of other suppliers), decides for one specific proposal, creates a corresponding Purchase Order and sends this to the supplier -* The supplier receives the Purchase Order and continues the process - -The shown use-case does not claim to be complete. For example, no Master Service Agreements are involved, and a productive process would continue with additional steps including Delivery Notes, Invoices and Payments, which not in the scope of this demo. - -The participants discovered the following challenges to be addressed indispensably: - -* Establishing a non-centralized rendezvous point for multiparty business process automation, with such place also providing a solution for automating the setup of a baseline environment for each process participant (here: a supplier or a buyer) on its own infrastructure (i.e., using the participant's own AWS or Microsoft Azure credentials); and -* Establishing a minimum domain model, abstracting from the baseline target objects and offering a process oriented entry point for systems of record to integrate; and -* Integrating systems of record via a suitable service interface. - -The proposed architecture and solutions to these challenges are presented in the next sections. - -## Architecture Proposal - -The main idea is to orchestrate the container environment for each baseline participant in a way it supports the addressing of the mentioned challenges at best. - -Baseline itself is a microservice architecture, where the different components of this architecture are residing in docker containers. The existing radish demo applies a UI on top of this architecture to play through the demo case. - -The architecture proposal of this demo builds upon the existing microservices, and adds layers to extract communication and integration with baseline towards an external system. - -![Shuttle Microservice Containers](../../examples\bri-1\lib\erp-connector-proxy\docs\images\image6.png)\ -**Microservice container environment for a participant in a baselined business process.** - -**Baseline Containers**: The microservices providing the Baseline Protocol and Radish34 use-case, based on this [branch](https://github.com/ethereum-oasis/baseline/tree/init-core) in GitHub, including several key fixes (i.e., unwiring cyclic dependencies within the existing Radish34 environment) and enhancements (i.e., point-to-point messaging between parties, use of a generalized circuit for baselining agreements). - -**Provide Containers**: Provide's identity, key management, blockchain and messaging microservice API containers representing the technical entry point and translation layer for data and baseline protocol messages, and the provider of messaging infrastructure leveraged by the Baseline stack for secure point-to-point messaging. - -**Unibright Proxy**: An extraction of the Unibright Connector (a blockchain integration platform), consisting of a simplified, context-related domain model and a RESTful api to integrate off-chain systems. - -**The actual system of record is integrated by on premise or cloud based integration software in the domain of the respective Operator, leading to the "full stack."** - -**Each role in the process should run its own full-stack, connecting to the standardized Unibright Proxy by way of** [**Shuttle**](https://shuttle.provide.services)**.** - -## Challenge: Automating the setup of a baseline environment for each process participant - -Implementing the demo use-case as described and demonstrated herein arguably illustrates levels of technical and operational complexity that would prevent most organizations from successfully applying the Baseline approach to their processes. - -A viable rendezvous point where every participant in a multiparty business process can "meet in the middle" to ensure common agreements exists between each party (i.e., agreement on the use-case/solution) and each technical team (i.e., agreement on the protocols, data models, integration points, etc.) is a prerequisite to starting any actual technical integration. Such a rendezvous point can only be considered "viable" if it: - -* is non-centralized; and -* can automate container orchestration across major infrastructure vendors (i.e., AWS and Microsoft Azure); and -* it can provide atomicity guarantees across all participants' container runtimes during protocol upgrades (i.e., to ensure forward compatibility and continuity for early adopters) - -Shuttle is a bring-your-own-keys rendezvous point enabling turnkey container orchestration and integration across infrastructure vendors. Shuttle de-risks multiparty enterprise "production experiments " using the Baseline Protocol, providing continuity to early adopters of the Baseline approach. Provide is actively contributing to the standards and protocol while commercially supporting Shuttle projects. - -The following complexities related to enabling the Baseline Protocol for a multiparty process such as the one illustrated by the Radish34 use-case are addressed by Shuttle as an enterprise rendezvous point: - -* Infrastructure - * Container Orchestration - * Security - * Dependency Graph - * Blockchain - * HD Wallets / Accounts - * Meta transaction relay (i.e., enterprise "gas pump") - * Smart Contracts (i.e., deployment, interaction) - * Organization Identity / PKI / x509 - * Key material (i.e., for advanced privacy, messaging, zkSNARKs -* Baseline Protocol - * Circuit Registry - * Continuity & forward-compatibility (i.e., with rapidly-evolving protocols) - * Point-to-point messaging (i.e., proof receipts, etc.) - * Translation for DTO → Baseline Protocol - -Baseline smart contract deployment to Ropsten testnet -- as of today, new projects are automatically subsidized by the Provide platform faucet when transaction broadcasts fail due to insufficient funds on every testnet. This same meta transaction / relay functionality will be helpful to organizations who want to participate in mainnet-enabled business processes in the future but do not want to hold Ether (i.e., when the Baseline Protocol has been deployed to the public Ethereum mainnet).\* - -Baseline smart contract suite intricacy, as illustrated by the contract-internal CREATE opcodes issued from within the Shuttle deployer contract. This functionality will become a standardized part of the Baseline protocol.\* - -Container orchestration "work product" -- each organization, using its own AWS/Azure credentials, leverages Shuttle to automate the configuration and deployment of 13 microservice container runtimes to cloud infrastructure under their own auspices. Provide also has capability of supporting this for on-premise deployments via a rack appliance.\* - -## Challenge: Establishing Domain Model and Proxy - -As the Baseline Protocol itself is still in its bootstrapping phase, it was not possible to just use a perfectly working "Baseline" endpoint, and feeding it with perfectly designed and standardized data for the use case. To establish a development environment, in which all participants (e.g. distributed software teams) can continue working and are not blocking each other. One solution to this can be a proxy. - -A proxy is an intermediate layer that you establish in an integration process. The proxy only consists of simple domain model descriptions and basic operations like "Get List of Objects", "Get Specific Object" or "Create new Specific object". So we created a Domain Model for the procurement use case we wanted to show, and designed basic DTOs ("Data Transfer Objects") for all the object types involved, like RequestForProposals, Proposals, PurchaseOrders and so on. We also generated a service interface for all these DTOs automatically, and an authentication service as well. - -The proxy defines the entry point for all integration partners in the use case scenario, agreeing on a common domain model and service layer. Still, every participant runs its own proxy, keeping the decentralised structure in place. - -The proxy does not perform any business logic on its own (apart from some basic example mappings to make the first setup easier). The proxy leverages the local Provide stack as a gateway to the Baseline Protocol by way of [this](https://github.com/provideservices/provide-dotnet) open-source NuGet package. - -## Challenge: Integrating Systems of Record - -### SAP ERP Integration - -To help baselining SAP environments (following the Buyer role in this demo), Unibright configured the Unibright Connector (the integration platform of the Unibright Framework) to integrate and map the SAP models with the proxy automatically. - -**Object Mapping in the Unibright Connector** - -**SAP Main Navigation Hierarchy for Purchasing Process, incl ME49 -> Price Comparison** - -**Request for Quotation for 2 materials** - -**Quotation to the Request, incl PriceScale referenced to the OrderItem** - -**Resulting Purchase Order for Supplier ("Vendor" 100073)** - -**Using the action Dashboard of the webversion of the Unibright connector to monitor SAP** **<> Proxy communication** - -### Microsoft Dynamics - -To help baselining Dynamics 365 environments, Envision Blockchain built an extension called Radish34 for Dynamics 365 Finance and Operations. While this demo is showing the Dynamics 365 Supplier environment, it's important to note that the Radish34 extension is dually configured to support both roles (Buyer and Supplier). Below is a diagram showing the specific Dynamics 365 Finance and Operation modules used and the objects that are passing through the Radish34 extension. - -**Radish34 Implementation Flow Chart** - -After importing the extension, organizations will need to configure parameters to interact with the Unibright Proxy, setup Customer codes, Vendor codes, and setup custom Number sequences (which creates identifiers for Dynamics 365 objects). - -**Radish34 Parameter Module** - -Supplier Role - -When setting up Customers, you'll need to identify customers using the Customer Setup Module and input the External code used in the Radish Module. The Value is automatically filled out by the proxy. - -**Customer Setup Module** - -You can use the Radish34 service operations feature to make periodic or on-demand calls of the UB Proxy and receive RFPs. - -**Radish34 Service Operations Module** - -You can use the Sales Quotation module to view, adjust the prices for the items the Buyer is requesting, and send the quotation. - -**Sales Quotation Module** - -The Radish 34 Outgoing Proposals module allows you to approve, and send the proposal to the Buyer - -**Radish34 Outgoing Proposals Module** - -The Radish 34 Service Operations module will periodically check for incoming purchase orders from the Buyer - -**Radish34 Service Operations Module (Unchecked for incoming purchase orders)** - -The Sales Order modules to look at the approved proposal from the Buyer and confirm the sales order - -**Sales Order module** diff --git a/docs/connectors/msft-excel-connector.md b/docs/connectors/msft-excel-connector.md deleted file mode 100644 index c114595e1..000000000 --- a/docs/connectors/msft-excel-connector.md +++ /dev/null @@ -1,3 +0,0 @@ -# MSFT Excel Connector - -The Microsoft Excel Connector project is nearly complete and published. Stay tuned for release shortly. diff --git a/docs/deprecated-work/baseline-protocol-code/baseline-process.md b/docs/deprecated-work/baseline-protocol-code/baseline-process.md index c49115c36..93ea8d221 100644 --- a/docs/deprecated-work/baseline-protocol-code/baseline-process.md +++ b/docs/deprecated-work/baseline-protocol-code/baseline-process.md @@ -4,7 +4,7 @@ Parties store data in local systems of record (Mongo, Oracle, SAP, etc). Components involved in the baseline process are given CRUD access to this and conduct a series of operations to serialize records (including any associated business logic), send those records to counterparties, receive the records, sign them, generate proofs, and store these proofs to a Merkle Tree on the Mainnet. -Connectors for various systems can be found [here](https://github.com/ethereum-oasis/baseline/tree/master/examples/bri-1/lib). +[Example Connectors](https://github.com/ethereum-oasis-op/baseline/tree/main/examples/bri-1/lib) are available for various systems. ## Setting up the Workgroup @@ -35,18 +35,18 @@ Before creating a Workflow, you must first create the business rules involved in More elaborate Workflows may contain rules that govern the state changes from one Workstep to the next. These can be written in zero knowledge circuits, and in a future release, one will be able to send business logic to counterparties without constructing special zk circuits (but allowing the core zk "consistency" circuit to check both code and data). -To set up this business logic, use the Baseline Protocol Privacy Package [here](https://github.com/ethereum-oasis/baseline/tree/master/core/privacy). +To set up this business logic, use the [Baseline Protocol Privacy Package](https://github.com/ethereum-oasis-op/baseline/tree/main/core/privacy). ### Deploying the Contracts Once the business logic is rendered into provers, deploy the Workflow as follows: -First deploy a Node that has the baseline protocol RPC interface implemented. The Nethermind Ethereum Client is the first to implement this code. Alternatively, you can deploy the [commit-mgr](https://github.com/ethereum-oasis/baseline/tree/master/examples/bri-2/commit-mgr) Ethereum client extension plus a client type of your choice (i.e. Besu, Infura, etc.) +First deploy a Node that has the baseline protocol RPC interface implemented. The Nethermind Ethereum Client is the first to implement this code. Alternatively, you can deploy the [commit-mgr](https://github.com/ethereum-oasis-op/baseline/tree/main/examples/bri-2/commit-mgr) Ethereum client extension plus a client type of your choice (i.e. Besu, Infura, etc.) -Next, use the `IBaselineRPC` call in the Client to deploy the Shield and Verifier contracts on-chain. This can be found [here](https://github.com/ethereum-oasis/baseline/tree/master/core/api). +Next, use the `IBaselineRPC` call in the Client to deploy the Shield and Verifier contracts on-chain. This can be found [here](https://github.com/ethereum-oasis-op/baseline/tree/main/core/api). ### Running Worksteps Now that the Workgroup and Workflow have been established, counterparties can send each other serialized records, confirm consistency between those records, and enforce business rules on the state changes from Workstep to Workstep. -An example of this is in the BRI-1 Reference implementation [here](https://github.com/ethereum-oasis/baseline/tree/master/examples/bri-1). And a walkthrough of an "Alice and Bob" simple case is [here](https://youtu.be/2WXvTHR4\_7Q) and [here](https://youtu.be/R0AEww6fKLk). +An example of this is in the BRI-1 Reference implementation [here](https://github.com/ethereum-oasis-op/baseline/tree/main/examples/bri-1). And a walkthrough of an "Alice and Bob" simple case is [here](https://youtu.be/2WXvTHR4\_7Q) and [here](https://youtu.be/R0AEww6fKLk). diff --git a/docs/deprecated-work/baseline-protocol-code/developer-resources.md b/docs/deprecated-work/baseline-protocol-code/developer-resources.md index 1f9479ad2..ee8f20e31 100644 --- a/docs/deprecated-work/baseline-protocol-code/developer-resources.md +++ b/docs/deprecated-work/baseline-protocol-code/developer-resources.md @@ -5,8 +5,8 @@ If you want to build with the Baseline Protocol, you will find these helpful: | Resource | Quick Access | | ---------------------------- | ---------------------------------------------------------------------------------------------------------- | | v1.0 Code base documentation | [Here](packages/) | -| v1.0 Code base | [Here](https://github.com/eea-oasis/baseline/tree/master/core) | -| Branch naming standard | [Here] (./branch-naming.md) | | +| v1.0 Code base | [Here](https://github.com/ethereum-oasis-op/baseline/tree/main/core) | +| Branch naming standard | [Here](https://github.com/ethereum-oasis-op/baseline/tree/main/docs/deprecated-work/baseline-protocol-code/branch-naming.md) | | | Implementation guide | Soon | | Developers slack channel | [Here](https://join.slack.com/t/ethereum-baseline/shared\_invite/zt-d6emqeci-bjzBsXBqK4D7tBTZ40AEfQ): #dev | | Reference implementations | [Here](../bri/overview-of-reference-implementations.md) | diff --git a/docs/deprecated-work/baseline-protocol-code/packages/api.md b/docs/deprecated-work/baseline-protocol-code/packages/api.md index a446a356f..73dff3e42 100644 --- a/docs/deprecated-work/baseline-protocol-code/packages/api.md +++ b/docs/deprecated-work/baseline-protocol-code/packages/api.md @@ -36,7 +36,7 @@ An initial set of JSON-RPC methods have been defined for inclusion in the specif #### Ethereum clients that support baseline JSON-RPC * [Nethermind](https://github.com/NethermindEth/nethermind) .NET client -* Any client supported by the [commit-mgr](https://github.com/ethereum-oasis/baseline/tree/master/examples/bri-2/commit-mgr) service. These include: +* Any client supported by the [commit-mgr](https://github.com/ethereum-oasis-op/baseline/tree/main/examples/bri-2/commit-mgr) service. These include: * [ganache](https://github.com/trufflesuite/ganache) * [besu](https://github.com/hyperledger/besu) * [Infura](https://infura.io/docs/ethereum) diff --git a/docs/deprecated-work/baseline-protocol-code/packages/baseline.md b/docs/deprecated-work/baseline-protocol-code/packages/baseline.md index 9640619a6..926411c5d 100644 --- a/docs/deprecated-work/baseline-protocol-code/packages/baseline.md +++ b/docs/deprecated-work/baseline-protocol-code/packages/baseline.md @@ -35,7 +35,7 @@ An initial set of JSON-RPC methods have been defined for inclusion in the specif #### Ethereum clients that support baseline JSON-RPC * [Nethermind](https://github.com/NethermindEth/nethermind) .NET client -* Any client supported by the [commit-mgr](https://github.com/ethereum-oasis/baseline/tree/master/examples/bri-2/commit-mgr) service. These include: +* Any client supported by the [commit-mgr](https://github.com/ethereum-oasis-op/baseline/tree/main/examples/bri-2/commit-mgr) service. These include: * [ganache](https://github.com/trufflesuite/ganache) * [besu](https://github.com/hyperledger/besu) * [Infura](https://infura.io/docs/ethereum) diff --git a/docs/deprecated-work/bri/bri-1/README.md b/docs/deprecated-work/bri/bri-1/README.md index fce818b4c..ee13ba6fd 100644 --- a/docs/deprecated-work/bri/bri-1/README.md +++ b/docs/deprecated-work/bri/bri-1/README.md @@ -10,7 +10,7 @@ This reference implementation of the core interfaces specified in the v0.1 relea The reference implementation is instrumented to run on the Ethereum Ropsten testnet and can be configured to run on many other public or permissioned EVM-based blockchains. -The BRI-1 "base" example codebase can be found [here](https://github.com/ethereum-oasis/baseline/tree/master/examples/bri-1/base-example). +The BRI-1 "base" example codebase can be found [here](https://github.com/ethereum-oasis-op/baseline/tree/main/examples/bri-1/base-example). ## Provide Architecture diff --git a/docs/deprecated-work/bri/bri-1/bri-1-base-example.md b/docs/deprecated-work/bri/bri-1/bri-1-base-example.md index a6c871d25..7440171c9 100644 --- a/docs/deprecated-work/bri/bri-1/bri-1-base-example.md +++ b/docs/deprecated-work/bri/bri-1/bri-1-base-example.md @@ -11,7 +11,7 @@ The reference implementation runs on the Ethereum Ropsten testnet and can be con Clone the Baseline repository: ``` -git clone https://github.com/eea-oasis/baseline.git +git clone https://github.com/ethereum-oasis-op/baseline.git ``` Checkout the bri-1-privacy branch: diff --git a/docs/deprecated-work/bri/bri-1/bri-1-libraries/erp-connector-sap-microsoft-dynamics.md b/docs/deprecated-work/bri/bri-1/bri-1-libraries/erp-connector-sap-microsoft-dynamics.md index fb0175941..e336514db 100644 --- a/docs/deprecated-work/bri/bri-1/bri-1-libraries/erp-connector-sap-microsoft-dynamics.md +++ b/docs/deprecated-work/bri/bri-1/bri-1-libraries/erp-connector-sap-microsoft-dynamics.md @@ -53,7 +53,7 @@ The architecture proposal of this demo builds upon the existing microservices, a ![Shuttle Microservice Containers](docs/images/image5.png) **Microservice container environment for a participant in a baselined business process.**</sup> -**Baseline Containers**: The microservices providing the Baseline Protocol and Radish34 use-case, based on this [branch](https://github.com/ethereum-oasis/baseline/tree/init-core) in GitHub, including several key fixes \(i.e., unwiring cyclic dependencies within the existing Radish34 environment\) and enhancements \(i.e., point-to-point messaging between parties, use of a generalized circuit for baselining agreements\). +**Baseline Containers**: The microservices providing the Baseline Protocol and Radish34 use-case, based on this [branch](https://github.com/ethereum-oasis-op/baseline/tree/init-core) in GitHub, including several key fixes \(i.e., unwiring cyclic dependencies within the existing Radish34 environment\) and enhancements \(i.e., point-to-point messaging between parties, use of a generalized circuit for baselining agreements\). **Provide Containers**: Provide's identity, key management, blockchain and messaging microservice API containers representing the technical entry point and translation layer for data and baseline protocol messages, and the provider of messaging infrastructure leveraged by the Baseline stack for secure point-to-point messaging. diff --git a/docs/deprecated-work/bri/overview-of-reference-implementations.md b/docs/deprecated-work/bri/overview-of-reference-implementations.md index c0c136487..dc0466de2 100644 --- a/docs/deprecated-work/bri/overview-of-reference-implementations.md +++ b/docs/deprecated-work/bri/overview-of-reference-implementations.md @@ -13,7 +13,7 @@ The baseline initiative's primary mission is to standardize these abstract techn Both the core libraries and the reference implementations should be thought of as a starting point for developers, a way of understanding the techniques and getting a jump start on their own work. So long as a developer follows the standard specifications of the baseline protocol, their work should interoperate with anyone else's implementation. -If the core libraries and the reference implementations are just instances of the standard, why separate them into [core/](https://github.com/ethereum-oasis/baseline/tree/master/core) and different reference implementations (see [examples/](https://github.com/ethereum-oasis/baseline/tree/master/examples))? The answer is that the separation makes it easier to implement changes. The core should always be stable and capable of informing specifications development, where reference implementations are more "opinionated" and can constitute different approaches that utilize specific components, infrastructure, etc., while using the same core interfaces. +If the core libraries and the reference implementations are just instances of the standard, why separate them into [core/](https://github.com/ethereum-oasis-op/baseline/tree/main/core) and different reference implementations (see [examples/](https://github.com/ethereum-oasis-op/baseline/tree/main/examples))? The answer is that the separation makes it easier to implement changes. The core should always be stable and capable of informing specifications development, where reference implementations are more "opinionated" and can constitute different approaches that utilize specific components, infrastructure, etc., while using the same core interfaces. > The core libraries are rails for standardization while reference implementations are rails for adoption. @@ -23,9 +23,9 @@ Companies and individuals contributing to the Baseline Protocol are not putting To this end, Reference Implementations -- not unlike different implementations of the Ethereum Yellow Paper -- may build-in dependencies on specific products or add proprietary components and tools that might feature or advantage a company or group of companies. This is allowed -- and encouraged -- so long as **the Reference Implementation does not introduce confusing naming or positioning that would give a developer the sense that those elements are essential for **_**baselining**_. That said, the best Reference Implementations will endeavor to be modular so that their work can be used with a variety of components without someone having to perform "surgery" on the code. -Over time, it is expected that many implementations -- both proprietary and otherwise -- will be developed and not submitted back into the Baseline Protocol open source repository. But the community is grateful to those companies and individuals that \_provide \_their work as contributions back to open source. These contributions are stored in the [examples/ ](https://github.com/ethereum-oasis/baseline/tree/master/examples)folder of the repository under the naming convention below. +Over time, it is expected that many implementations -- both proprietary and otherwise -- will be developed and not submitted back into the Baseline Protocol open source repository. But the community is grateful to those companies and individuals that \_provide \_their work as contributions back to open source. These contributions are stored in the [examples/ ](https://github.com/ethereum-oasis-op/baseline/tree/main/examples)folder of the repository under the naming convention below. -_Note: All source code in the Baseline Protocol_ [_repository_](https://github.com/ethereum-oasis/baseline) _is licensed under the Public Domain CC0-Universal license; it can be forked and any of its contents can be copied and used by others at will._ +_Note: All source code in the Baseline Protocol_ [_repository_](https://github.com/ethereum-oasis-op/baseline) _is licensed under the Public Domain CC0-Universal license; it can be forked and any of its contents can be copied and used by others at will._ ### Naming & Conventions @@ -43,9 +43,9 @@ Radish34 might be called BRI-0, but for historical purposes, and so as not to co ### **BRI-1** -Baseline Reference Implementation #1 ([BRI-1](bri-1/)) was developed by contributors from Provide, Nethermind, EY and others, with support and oversight from the entire Baseline Maintainer team. This implementation correctly utilizes the core Baseline Protocol abstract interfaces, which are free of dependencies on any particular set of components or proprietary systems, but it also relies heavily on tools and systems made available by Provide. Provide's [Shuttle](https://shuttle.provide.services/waitlist) infrastructure deployment and manifold system is used by many \_baselining \_developers to make their work easier. Nethermind is the first Ethereum public client to implement the `IBaselineRPC` interface (found [here](https://github.com/ethereum-oasis/baseline/tree/master/core/api#interfaces)). NATS is a production-ready enterprise messaging layer that meets the privacy and performance requirements for baselining. +Baseline Reference Implementation #1 ([BRI-1](bri-1/)) was developed by contributors from Provide, Nethermind, EY and others, with support and oversight from the entire Baseline Maintainer team. This implementation correctly utilizes the core Baseline Protocol abstract interfaces, which are free of dependencies on any particular set of components or proprietary systems, but it also relies heavily on tools and systems made available by Provide. Provide's [Shuttle](https://shuttle.provide.services/waitlist) infrastructure deployment and manifold system is used by many \_baselining \_developers to make their work easier. Nethermind is the first Ethereum public client to implement the [`IBaselineRPC` interface](https://github.com/ethereum-oasis-op/baseline/tree/main/core/api#interfaces)). NATS is a production-ready enterprise messaging layer that meets the privacy and performance requirements for baselining. -Details on BRI-1 can be found [here](bri-1/), and the code can be found [here](https://github.com/ethereum-oasis/baseline/tree/master/examples/bri-1). +Details on BRI-1 can be found [here](bri-1/), and the code can be found [here](https://github.com/ethereum-oasis-op/baseline/tree/main/examples/bri-1). ### **BRI-2** diff --git a/docs/deprecated-work/bri/radish34/modifying-radish34.md b/docs/deprecated-work/bri/radish34/modifying-radish34.md index ac0ac2998..eec4b6b27 100644 --- a/docs/deprecated-work/bri/radish34/modifying-radish34.md +++ b/docs/deprecated-work/bri/radish34/modifying-radish34.md @@ -4,7 +4,7 @@ The Radish34 functional proof-of-concept \(POC\) demonstrates only a few key ste But what if you wanted to add tokenized inventory, shipping & logistics, invoicing, or trade finance functions like invoice factoring? -As a POC, it is certainly true that the [code](https://github.com/ethereum-oasis/baseline/tree/master/examples/radish34) of Radish34 still needs to add a layer of abstraction to take it to the next level as production-capable code for supply chain applications. This would be a good place for community members to chip in, irrespective of the additional generalization effort of going from [POC to Protocol](from-poc-to-protocol.md). +As a POC, it is certainly true that the [code](https://github.com/ethereum-oasis-op/baseline/tree/main/examples/radish34) of Radish34 still needs to add a layer of abstraction to take it to the next level as production-capable code for supply chain applications. This would be a good place for community members to chip in, irrespective of the additional generalization effort of going from [POC to Protocol](from-poc-to-protocol.md). An example of this is the code for the MSA, which you can find in the repo \[ here \]. Strictly speaking, the MSA is an instance of a Workflow [Step](https://docs.baseline-protocol.org/baseline-basics/glossary#workstep). A Workstep can implement a number of Tasks. The MSA implements, for example, a specialized zero knowledge circuit specially written to enforce the correctness of the business logic involved in calculating a PO’s correct volume discount. It also implements general [Tasks](https://docs.baseline-protocol.org/baseline-basics/glossary#task), such as messaging, digital signatures, and the process of generating, validating and storing the proof \(in this case, a state marker representing the rate table and the total number of units ordered\), and nullifying a previous proof when the state has changed. diff --git a/docs/deprecated-work/bri/radish34/radish34-poc.md b/docs/deprecated-work/bri/radish34/radish34-poc.md index d3fa1f713..28c5f4c82 100644 --- a/docs/deprecated-work/bri/radish34/radish34-poc.md +++ b/docs/deprecated-work/bri/radish34/radish34-poc.md @@ -1,4 +1,4 @@ # Radish34 POC -If you’ve read the [Radish34 Explained](radish34-explained.md) section or played with the [user experience demo](radish34-interactive-demo.md) and now want to build and run the POC yourself, you’re in the right place. Find the authoritative set-up documentation in the Github repo [here](https://github.com/ethereum-oasis/baseline/tree/master/examples/radish34). +If you’ve read the [Radish34 Explained](radish34-explained.md) section or played with the [user experience demo](radish34-interactive-demo.md) and now want to build and run the POC yourself, you’re in the right place. Find the authoritative set-up documentation in the Github repo [here](https://github.com/ethereum-oasis-op/baseline/tree/main/examples/radish34). diff --git a/docs/deprecated-work/core/api/LICENSE b/docs/deprecated-work/core/api/LICENSE index afb8d8019..659e1b181 100644 --- a/docs/deprecated-work/core/api/LICENSE +++ b/docs/deprecated-work/core/api/LICENSE @@ -1,6 +1,6 @@ This Open Project operates under the license below. OASIS invites anyone who knows of any IPR claims to disclose them if they may be essential to the implementation of any of the work of this project so that notice of them may be posted. -For information on any statements regarding IPR claims related to the work of this project, see the [OASIS OP IPR Statements](https://github.com/oasis-open-projects/administration/blob/master/IPR_STATEMENTS.md) page. +For information on any statements regarding IPR claims related to the work of this project, see the [OASIS OP IPR Statements](https://github.com/oasis-open-projects/administration/blob/main/IPR_STATEMENTS.md) page. # CC0 1.0 Universal diff --git a/docs/deprecated-work/core/api/README.md b/docs/deprecated-work/core/api/README.md index c0a0d3153..93384cd7e 100644 --- a/docs/deprecated-work/core/api/README.md +++ b/docs/deprecated-work/core/api/README.md @@ -105,5 +105,5 @@ deleteVaultSecret(vaultId: string, secretId: string): Promise; The following providers of the Baseline API are available: - Ethers.js - *example provider; not yet implemented* -- [Provide](https://provide.services) - enterprise-grade reference implementation (see [examples/bri-1/base-example](https://github.com/ethereum-oasis/baseline/tree/master/examples/bri-1/base-example)) +- [Provide](https://provide.services) - enterprise-grade reference implementation (see [examples/bri-1/base-example](https://github.com/ethereum-oasis-op/baseline/tree/main/examples/bri-1/base-example)) - RPC - generic JSON-RPC provider diff --git a/docs/deprecated-work/core/contracts/LICENSE b/docs/deprecated-work/core/contracts/LICENSE index afb8d8019..659e1b181 100644 --- a/docs/deprecated-work/core/contracts/LICENSE +++ b/docs/deprecated-work/core/contracts/LICENSE @@ -1,6 +1,6 @@ This Open Project operates under the license below. OASIS invites anyone who knows of any IPR claims to disclose them if they may be essential to the implementation of any of the work of this project so that notice of them may be posted. -For information on any statements regarding IPR claims related to the work of this project, see the [OASIS OP IPR Statements](https://github.com/oasis-open-projects/administration/blob/master/IPR_STATEMENTS.md) page. +For information on any statements regarding IPR claims related to the work of this project, see the [OASIS OP IPR Statements](https://github.com/oasis-open-projects/administration/blob/main/IPR_STATEMENTS.md) page. # CC0 1.0 Universal diff --git a/docs/deprecated-work/core/messaging/LICENSE b/docs/deprecated-work/core/messaging/LICENSE index afb8d8019..659e1b181 100644 --- a/docs/deprecated-work/core/messaging/LICENSE +++ b/docs/deprecated-work/core/messaging/LICENSE @@ -1,6 +1,6 @@ This Open Project operates under the license below. OASIS invites anyone who knows of any IPR claims to disclose them if they may be essential to the implementation of any of the work of this project so that notice of them may be posted. -For information on any statements regarding IPR claims related to the work of this project, see the [OASIS OP IPR Statements](https://github.com/oasis-open-projects/administration/blob/master/IPR_STATEMENTS.md) page. +For information on any statements regarding IPR claims related to the work of this project, see the [OASIS OP IPR Statements](https://github.com/oasis-open-projects/administration/blob/main/IPR_STATEMENTS.md) page. # CC0 1.0 Universal diff --git a/docs/deprecated-work/core/persistence/LICENSE b/docs/deprecated-work/core/persistence/LICENSE index afb8d8019..659e1b181 100644 --- a/docs/deprecated-work/core/persistence/LICENSE +++ b/docs/deprecated-work/core/persistence/LICENSE @@ -1,6 +1,6 @@ This Open Project operates under the license below. OASIS invites anyone who knows of any IPR claims to disclose them if they may be essential to the implementation of any of the work of this project so that notice of them may be posted. -For information on any statements regarding IPR claims related to the work of this project, see the [OASIS OP IPR Statements](https://github.com/oasis-open-projects/administration/blob/master/IPR_STATEMENTS.md) page. +For information on any statements regarding IPR claims related to the work of this project, see the [OASIS OP IPR Statements](https://github.com/oasis-open-projects/administration/blob/main/IPR_STATEMENTS.md) page. # CC0 1.0 Universal diff --git a/docs/deprecated-work/core/privacy/LICENSE b/docs/deprecated-work/core/privacy/LICENSE index afb8d8019..659e1b181 100644 --- a/docs/deprecated-work/core/privacy/LICENSE +++ b/docs/deprecated-work/core/privacy/LICENSE @@ -1,6 +1,6 @@ This Open Project operates under the license below. OASIS invites anyone who knows of any IPR claims to disclose them if they may be essential to the implementation of any of the work of this project so that notice of them may be posted. -For information on any statements regarding IPR claims related to the work of this project, see the [OASIS OP IPR Statements](https://github.com/oasis-open-projects/administration/blob/master/IPR_STATEMENTS.md) page. +For information on any statements regarding IPR claims related to the work of this project, see the [OASIS OP IPR Statements](https://github.com/oasis-open-projects/administration/blob/main/IPR_STATEMENTS.md) page. # CC0 1.0 Universal diff --git a/docs/deprecated-work/core/types/LICENSE b/docs/deprecated-work/core/types/LICENSE index afb8d8019..659e1b181 100644 --- a/docs/deprecated-work/core/types/LICENSE +++ b/docs/deprecated-work/core/types/LICENSE @@ -1,6 +1,6 @@ This Open Project operates under the license below. OASIS invites anyone who knows of any IPR claims to disclose them if they may be essential to the implementation of any of the work of this project so that notice of them may be posted. -For information on any statements regarding IPR claims related to the work of this project, see the [OASIS OP IPR Statements](https://github.com/oasis-open-projects/administration/blob/master/IPR_STATEMENTS.md) page. +For information on any statements regarding IPR claims related to the work of this project, see the [OASIS OP IPR Statements](https://github.com/oasis-open-projects/administration/blob/main/IPR_STATEMENTS.md) page. # CC0 1.0 Universal diff --git a/docs/governance/governance.md b/docs/governance/governance.md index d0ee76d72..8f8977fe6 100644 --- a/docs/governance/governance.md +++ b/docs/governance/governance.md @@ -6,15 +6,15 @@ description: The Baseline Protocol is an openly governed project and standards b ## License and Patent Policies -All repos in the Ethereum OASIS organization, including Baseline Protocol repositories, adhere to OASIS Open Projects [license](https://github.com/oasis-open-projects/documentation/blob/master/policy/licenses.md) and [patent polices](https://github.com/oasis-open-projects/documentation/blob/master/policy/call-for-patent-disclosure.md). +All repos in the Ethereum OASIS organization, including Baseline Protocol repositories, adhere to OASIS Open Projects [license](https://github.com/oasis-open-projects/documentation/blob/main/policy/licenses.md) and [patent polices](https://github.com/oasis-open-projects/documentation/blob/main/policy/call-for-patent-disclosure.md). Contributions to the open source repo shall be under creative commons public domain license [(CC0 1.0 Universal)](https://creativecommons.org/publicdomain/zero/1.0/). -In order to ensure clean IPR that allows the Baseline Protocol to remain an open technology, OASIS rules require an [Entity CLA](https://www.oasis-open.org/resources/projects/cla/projects-entity-cla) for persons or organizations contributing on behalf of a legal entity, and an [Individual CLA](http://cla-assistant.io/ethereum-oasis/baseline) for community contributions. You must [sign the ICLA](http://cla-assistant.io/ethereum-oasis/baseline) before your pull requests to the baseline repository will be merged. [Check here](https://www.oasis-open.org/resources/projects/cla/projects-view-entity-cla) to see if your company has signed the ECLA. +In order to ensure clean IPR that allows the Baseline Protocol to remain an open technology, OASIS rules require an [Entity CLA](https://www.oasis-open.org/resources/projects/cla/projects-entity-cla) for persons or organizations contributing on behalf of a legal entity, and an [Individual CLA](http://cla-assistant.io/ethereum-oasis-op/baseline) for community contributions. You must [sign the ICLA](http://cla-assistant.io/ethereum-oasis-op/baseline) before your pull requests to the baseline repository will be merged. [Check here](https://www.oasis-open.org/resources/projects/cla/projects-view-entity-cla) to see if your company has signed the ECLA. ## Code of Conduct -​Here is the link to the official [Code of Conduct](https://github.com/ethereum-oasis/baseline/blob/master/CODE\_OF\_CONDUCT.md). +​Here is the official [Code of Conduct](https://github.com/ethereum-oasis-op/baseline/blob/main/CODE\_OF\_CONDUCT.md). ## **Charter: Baseline Open Source Project Governance** @@ -65,7 +65,7 @@ Baseline Maintainers have advanced code repository permissions and responsibilit First, one must attend at least two consecutive Baseline Core Dev meetings and contribute to the project through PRs, workgroups, or other contributions. E-mail baseline-team@oasis-open.org to be added to the Core Devs meeting invite. -Then complete the [Pull_Request_Template](https://github.com/eea-oasis/baseline/blob/main/.github/PULL_REQUEST_TEMPLATE.md) in its entirety to add your Github ID to the [Code Owners file](https://github.com/eea-oasis/baseline/blob/main/.github/CODEOWNERS).The current Maintainers will be assigned to review the Pull Request, and the PR will be merged through the PR approval process. +Then complete the [Pull_Request_Template](https://github.com/ethereum-oasis-op/baseline/blob/main/.github/PULL_REQUEST_TEMPLATE.md) in its entirety to add your Github ID to the [Code Owners file](https://github.com/ethereum-oasis-op/baseline/blob/main/.github/CODEOWNERS).The current Maintainers will be assigned to review the Pull Request, and the PR will be merged through the PR approval process. If the Baseline Maintainer request is denied or poses concerns, the proposer or other Baseline Core Devs can escalate to the TSC by informing Oasis or a TSC member. @@ -75,7 +75,7 @@ Maintainers must notify the private 'maintainer' Slack group or a community lead The initial number of maintainers required to merge a pull request to the main repository in Github is three, but may be amended to no fewer than two by a simple majority of the maintainers. -Maintainers are expected to review PRs in a timely manner, follow project guidelines (for branch, PR, code, testing, etc.), be reliable for assigned issues, and follow the [Code of Conduct](https://github.com/eea-oasis/baseline/blob/main/CODE_OF_CONDUCT.md). +Maintainers are expected to review PRs in a timely manner, follow project guidelines (for branch, PR, code, testing, etc.), be reliable for assigned issues, and follow the [Code of Conduct](https://github.com/ethereum-oasis-op/baseline/blob/main/CODE_OF_CONDUCT.md). #### Removal To step away from being a Baseline Maintainer, notify the other Maintainers or TSC members that you would like to relinquish your Baseline Maintainer status. @@ -84,7 +84,7 @@ If a Maintainer misses three consecutive meetings without prior notice, a commun If a Maintainer is removed due to the attendance policy and wants to recommit, they must attend 2 consecutive Core Dev sessions, notify the group of intent to re-commit, then submit the PR to be added back to the Code Owners File. -Maintainers can also be voted for removal for violating the Code of Conduct (https://github.com/eea-oasis/baseline/blob/main/CODE_OF_CONDUCT.md) or expectations. +Maintainers can also be voted for removal for violating the Code of Conduct (https://github.com/ethereum-oasis-op/baseline/blob/main/CODE_OF_CONDUCT.md) or expectations. Two-thirds of all current Maintainers constitute a quorum for a meeting involving a question of removal. A simple majority vote from Maintainers is required to remove a Maintainer, but the TSC may be brought in to arbitrate if the Baseline Maintainer to be removed or any other community members wish to dispute the action. @@ -103,5 +103,5 @@ This document was ratified by the PGB before the public launch of the Baseline P ### Details on OASIS and the Open Ethereum Project -Governance documents from the existing [Open Ethereum Project](https://github.com/ethereum-oasis/oasis-open-project/blob/master/GOVERNANCE.md%E2%80%8B). +Governance documents from the existing [Open Ethereum Project](https://github.com/ethereum-oasis-op/oasis-open-project/blob/main/GOVERNANCE.md%E2%80%8B). diff --git a/docs/specs/README.md b/docs/specs/README.md index 4ee2c5bbe..883003515 100644 --- a/docs/specs/README.md +++ b/docs/specs/README.md @@ -1,6 +1,6 @@ # Baseline Protocol Specifications -![Baseline Logo](https://raw.githubusercontent.com/ethereum-oasis/baseline/master/docs/assets/baseline-logo/Web/examples/PNGs/horizontal/baselineHorizontal-Logo-FullColor.png) +![Baseline Logo](https://raw.githubusercontent.com/ethereum-oasis-op/baseline/main/docs/assets/baseline-logo/Web/examples/PNGs/horizontal/baselineHorizontal-Logo-FullColor.png) *Read the full documentation [here at docs.baseline-protocol.org](https://docs.baseline-protocol.org/).* *Join our [Slack workspace](https://communityinviter.com/apps/ethereum-baseline/join-us), [Discord channel](https://discord.com/invite/NE8AYD7), [Telegram channel](https://t.me/baselineprotocol) and follow us on [Twitter](https://twitter.com/baselineproto) for Baseline news and updates!* @@ -21,15 +21,15 @@ The Baseline protocol specifications are currently work in progress. There are currently three specifications in development: -Oasis Standard 1 - The Baseline CORE Specifications document: The document describes the minimal set of business and technical prerequisites, functional and non-functional requirements, together with a reference architecture that when implemented ensures that two or more systems of record can synchronize their system state over a permissionless public Distributed Ledger Technology (DLT) network. +Oasis Standard 1 - The Baseline CORE Specifications document: The document describes the minimal set of business and technical prerequisites, functional and non-functional requirements, together with a reference architecture that when implemented ensures that two or more systems of record can synchronize their system state over a permissionless public Consensus Controlled State Machine (CCSM) network. [Link to Spec](https://github.com/ethereum-oasis-op/baseline-standard) -Oasis Standard 2 - The Baseline API & Data Model Specifications document: The document describes the Baseline programming interface and expected behaviors of all instances of this interface together with the required programming interface data model. +Oasis Standard 2 - The Baseline API & Data Model Specifications document: The document describes the Baseline programming interface and expected behaviors of all instances of this interface together with the required programming interface data model. [Link to Spec](https://github.com/ethereum-oasis-op/baseline-standard/tree/main/api) -Specification - Permissionless DLT Requirements document: The document describes required and assumed properties and qualities of a permissionless singleton state machine and its operating environment for such a permissionless DLT to safely synchronize two or more enterprise systems of record. +Oasis Standard 3 - Permissionless CCSM Requirements document: The document describes required and assumed properties and qualities of a permissionless singleton state machine and its operating environment for such a permissionless CCSM to safely synchronize two or more enterprise systems of record. [Link to Spec](https://github.com/ethereum-oasis-op/baseline-standard/tree/main/ccsm) ## License -All contribution in this repo is released under the CC0 1.0 Universal public domain dedication. For the full license text, refer to [LICENSE](https://github.com/ethereum-oasis/baseline/blob/master/LICENSE). +All contribution in this repo is released under the CC0 1.0 Universal public domain dedication. For the full license text, refer to [LICENSE](https://github.com/ethereum-oasis-op/baseline/blob/main/LICENSE). ## Contributions diff --git a/docs/specs/api/README.md b/docs/specs/api/README.md deleted file mode 100644 index 92a58172f..000000000 --- a/docs/specs/api/README.md +++ /dev/null @@ -1,51 +0,0 @@ -# Baseline Protocol Specifications - -![Baseline Logo](https://raw.githubusercontent.com/ethereum-oasis/baseline/master/docs/assets/baseline-logo/Web/examples/PNGs/horizontal/baselineHorizontal-Logo-FullColor.png) - -*Read the full documentation [here at docs.baseline-protocol.org](https://docs.baseline-protocol.org/).* -*Join our [Slack workspace](https://communityinviter.com/apps/ethereum-baseline/join-us), [Discord channel](https://discord.com/invite/NE8AYD7), [Telegram channel](https://t.me/baselineprotocol) and follow us on [Twitter](https://twitter.com/baselineproto) for Baseline news and updates!* - -## The Baseline API & Data Model Specification - -The document describes the Baseline programming interface and expected behaviors of all instances of this interface together with the required programming interface data model. - -## Status - -The Baseline API & Data Model Specification is currently work in progress. - -## Components - - - - - - - - - - - - - - - - - - - - - - - - - - -
ComponentComponent Description
IBaselineRPCDescribes interface that provide functions to interact with Agreement Execution Layer.
IRegistryDescribes interface that provide functions to manage workgroups, organizations and users.
IVaultDescribes interface that provide functions to manage vaults and keys.
IBlockchainServiceDescribes interface that provide functions for Blockchain clients.
Data ModelDescribes all required data structures and elements at each functional layer such as API data models or account structures.
- -## License - -All contribution in this repo is released under the CC0 1.0 Universal public domain dedication. For the full license text, refer to [LICENSE](https://github.com/ethereum-oasis/baseline/blob/master/LICENSE). - -## Contributions - -To participate in the evolution of Baseline via the specs process, please see our [Contributors Guidelines](https://docs.baseline-protocol.org/community/contributors). \ No newline at end of file diff --git a/docs/specs/api/baseline-api-v1.0-psd01.md b/docs/specs/api/baseline-api-v1.0-psd01.md deleted file mode 100644 index 8f4daf207..000000000 --- a/docs/specs/api/baseline-api-v1.0-psd01.md +++ /dev/null @@ -1,557 +0,0 @@ - -![OASIS Logo](http://docs.oasis-open.org/templates/OASISLogo-v2.0.jpg) -------- - -# Baseline API and Data Model Version 1.0 - -## Project Specification Draft 01 - -## 23 September 2020 - - - -#### Open Project: -[Baseline, part of the Ethereum OASIS Open Project](https://www.baseline-protocol.org/) - -#### Project Chair: -John Wolpert (john.wolpert@mesh.xyz), [ConsenSys](https://consensys.net/) - -#### Editors: -Anais Ofranc (aofranc@consianimis.com), [Consianimis](https://www.consianimis.com/) \ -Andreas Freund (a.freundhaskel@gmail.com) \ -Brian Chamberlain (brian.chamberlain@consensys.net), [ConsenSys](https://consensys.net/) \ -Charles ‘Chaals’ Nevile (charles.nevile@consensys.net), [ConsenSys](https://entethalliance.org/) \ -Daniel Norkin (daniel.norkin@envisionblockchain.com), [Envision Blockchain](https://envisionblockchain.com/) - - - -#### Related work: - - - -This specification is related to: \ -_Baseline Core Version 1.0_ - https://github.com/ethereum-oasis/baseline/tree/master/docs/specs/core - -#### Abstract: - -This document describes the Baseline programming interface and expected behaviors of all instances of this interface together with the required programming interface data model. - -#### Status: -This document is under active development and implementers are advised against implementing the specification unless they are directly involved with the Baseline TC team. -Comments on this work can be provided by opening issues in the project repository or by sending email to the project’s public comment list baseline@lists.oasis-open-projects.org. - -#### Key words: -The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [[RFC2119](#rfc2119)] and [[RFC8174](#rfc8174)] when, and only when, they appear in all capitals, as shown here. - -#### Citation format: -When referencing this specification the following citation format should be used: - -**[baseline-api-v1.0]** - -_Baseline API and Data Model Version 1.0_. Edited by X, Y, and Z. 23 September 2020. OASIS Project Specification Draft 01. https://docs.oasis-open.org/baseline/baseline-api/v1.0/psd01/baseline-api-v1.0-psd01.html. Latest stage: https://docs.oasis-open.org/baseline/baseline-api/v1.0/baseline-api-v1.0.html. - -------- - -## Notices -Copyright © OASIS Open 2020. All Rights Reserved. - -Distributed under the terms of the OASIS [IPR Policy](https://www.oasis-open.org/policies-guidelines/ipr). - -For complete copyright information please see the Notices section in the Appendix. - -------- - -# Table of Contents -[1 Introduction](#1-introduction) \ -    [1.1 Overview](#11-overview) \ -    [1.2 Glossary](#12-glossary) \ -    [1.3 Typographical Conventions](#13-typographical-conventions) \ -[2 Design and Architecture](#2-design-and-architecture) \ -[3 API](#3-api) \ -    [3.1 Org Management](#31-org-management) \ -        [3.1.1 IRegistry](#311-iregistry) \ -    [3.2 Messaging](#32-messaging) \ -        [3.2.1 IMessagingService](#321-imessagingservice) \ -    [3.3 Security](#33-security) \ -        [3.3.1 IVault](#331-ivault) \ -    [3.4 Agreement Execution](#34-agreement-execution) \ -        [3.4.1 IBaselineRPC](#341-ibaselinerpc) \ -        [3.4.2 IBlockchainService](#342-iblockchainservice) \ -    [3.5 Privacy](#35-privacy) \ -    [3.6 Persistence](#36-persistence) \ -        [3.6.1 IPersistenceService](#361-ipersistenceservice) \ -    [3.7 API Metadata](#37-api-metadata) \ -[4 Data Model](#4-data-model) \ -    [4.1 Org Management](#41-org-management) \ -    [4.2 Messaging](#42-messaging) \ -    [4.3 Security](#43-security) \ -    [4.4 Agreement Execution](#44-agreement-execution) \ -    [4.5 Privacy](#45-privacy) \ -    [4.6 Persistence](#46-persistence) \ -[5 Security Considerations](#6-security-considerations) \ -[6 Conformance](#6-conformance) \ -    [9.1 API and Data Model Minimal Conformance Level]() \ -    [9.2 API and Data Model Conformance Level]()\ -[Appendix A. Acknowledgments]()\ -[Appendix B. Revision History]() - -------- - -# 1 Introduction - -## 1.1 Overview - - -## 1.2 Glossary - - -**Party:** - -**Workgroup:** - - -**Workflow:** - -**Workstep:** - -**Baselining:** - - -**Task:** - - -**Lifecycle:** - -**Circuit Breaker:** - -**Portability:** - -**Interoperability:** - - -## 1.3 Typographical Conventions - -- Naming conventions -- Font colors and styles -- Typographic conventions - - -------- - -# 2 Design and Architecture - -This section defines the key concepts and architectural principles of the API and Data model(s). - - -------- - -# 3 API - -## 3.1 Org Management - -Describes interface(s) providing functions to manage workgroups, organizations and users. - -### 3.1.1 IRegistry - -This interface provides functions to manage workgroups, organizations and users. - -// workgroups - -| Requirement ID | Requirement | -| :--- | :--- | -| REG1 | #createWorkgroup(params: object): Promise;
description:
interface:
**Caveats:** | -| REG2| #updateWorkgroup(workgroupId: string, params: object): Promise;
description:
interface:
**Caveats:** | -| REG3| #fetchWorkgroups(params: object): Promise;
description:
interface:
**Caveats:** | -| REG4| #fetchWorkgroupDetails(workgroupId: string): Promise;
description:
interface:
**Caveats:** | -| REG5| #fetchWorkgroupOrganizations(workgroupId: string, params: object): Promise;
description:
interface:
**Caveats:** | -| REG6| #createWorkgroupOrganization(workgroupId: string, params: object): Promise;
description:
interface:
**Caveats:** | -| REG7| #updateWorkgroupOrganization(workgroupId: string, organizationId: string, params: object): Promise;
description:
interface:
**Caveats:** | -| REG8| #fetchWorkgroupInvitations(workgroupId: string, params: object): Promise;
description:
interface:
**Caveats:** | -| REG9| #fetchWorkgroupUsers(workgroupId: string, params: object): Promise;
description:
interface:
**Caveats:** | -| REG10| #createWorkgroupUser(workgroupId: string, params: object): Promise; | -| REG11| #updateWorkgroupUser(workgroupId: string, userId: string, params: object): Promise;
description:
interface:
**Caveats:** | -| REG12| #deleteWorkgroupUser(workgroupId: string, userId: string): Promise;
description:
interface:
**Caveats:** | - - -// organizations - -| Requirement ID | Requirement | -| :--- | :--- | -| REG13| createOrganization(params: object): Promise; | -| REG14| fetchOrganizations(params: object): Promise; | -| REG15| fetchOrganizationDetails(organizationId: string): Promise;| -| REG16| updateOrganization(organizationId: string, params: object): Promise;| - - -// organization users - -| Requirement ID | Requirement | -| :--- | :--- | -| REG17| fetchOrganizationInvitations(organizationId: string, params: object): Promise; | -| REG18| fetchOrganizationUsers(organizationId: string, params: object): Promise; | -| REG19| inviteOrganizationUser(organizationId: string, params: object): Promise;| - - - -## 3.2 Messaging - -Describes interface(s) providing functions to communicate with counterparties. - -### 3.2.1 IMessagingService - - -## 3.3 Security - -Describes interface(s) providing functions to manage vaults and keys and to handle digital signatures. - -### 3.3.1 IVault - -This interface provides functions to manage vaults and keys. - -| Requirement ID | Requirement | -| :--- | :--- | -| VAULT1 | createVault(params: object): Promise; | -| VAULT2| fetchVaults(params: object): Promise; | -| VAULT3| fetchVaultKeys(vaultId: string, params: object): Promise;| -| VAULT4| createVaultKey(vaultId: string, params: object): Promise; | -| VAULT5| deleteVaultKey(vaultId: string, keyId: string): Promise;| -| VAULT6| encrypt(vaultId: string, keyId: string, payload: string): Promise; | -| VAULT7| decrypt(vaultId: string, keyId: string, payload: string): Promise; | -| VAULT8| signMessage(vaultId: string, keyId: string, msg: string): Promise; | -| VAULT9| verifySignature(vaultId: string, keyId: string, msg: string, sig: string): Promise; | -| VAULT10| fetchVaultSecrets(vaultId: string, params: object): Promise; | -| VAULT11| createVaultSecret(vaultId: string, params: object): Promise; | -| VAULT12| deleteVaultSecret(vaultId: string, secretId: string): Promise; | - -## 3.4 Agreement Execution - - - -### 3.4.1 IBaselineRPC - -Contains RPC methods that are Remote Calls available by default. The solution ??MUST?? implement all those methods. - - -| Requirement ID | Requirement | -| :--- | :--- | -| BRPC1|**# track**
**Description:** Initializes a merkle tree database for the given Shield contract address and starts tracking new tree events.
**jsonrpc:** baseline_track
**Caveats:**
**Parameters:**
- DATA - address of the Shield contract
**Returns:**: -
**Example:**:| -| BRPC2|**# untrack**
**Description:** Removes event listeners for a single Shield contract.
**jsonrpc:** baseline_untrack
**Caveats:**
**Parameters:**
- DATA - address of the Shield contract
**Returns:**: -
**Example:**:| -| BRPC3|**# getTracked**
**Description:** Retrieves a list of the shield contract addresses being tracked and persisted.
**jsonrpc:** baseline_getTracked
**Caveats:**
**Parameters:** -
**Returns:**:
- Array<DATA> - list of all tracked Shield contracts
**Example:**:| -| BRPC4| **# getLeaf**
**Description:** Retrieves a single leaf from a tree at the given shield contract address.
**jsonrpc:** baseline_getLeaf
**Caveats:** only works if the contract is tracked, otherwise
**Returns:** an error
**Parameters:**
- DATA - Shield contract address
- QUANTITY - leaf index
**Returns:**:
- MERKLE_TRIE_NODE
**Example:**:| -| BRPC5| **# insertLeaf**
**Description:** Inserts a single leaf to atree at the given shield contract address.
**jsonrpc:** baseline_insertLeaf
**Caveats:** only works if the contract is tracked, otherwise
**Returns:** an error
**Parameters:**
- DATA - Shield contract address
- QUANTITY - leaf index
**Returns:**:
- MERKLE_TRIE_NODE
**Example:**:| -| BRPC6| **# getLeaves**
**Description:** Retrieves multiple leaves from a tree at the given shield contract address.
**jsonrpc:** baseline_getLeaves
**Caveats:** only works if the contract is tracked, otherwise
**Returns:** an error
**Parameters:**
- DATA - Shield contract address
- Array<QUANTITY> - leaf indexes
**Returns:**:
- Array<MERKLE_TRIE_NODE>
**Example:**:| -| BRPC7| **# getRoot**
**Description:** Retrieves the root of a tree at the given shield contract address .
**jsonrpc:** baseline_getRoot
**Caveats:** only works if the contract is tracked, otherwise
**Returns:** an error
**Parameters:**
- DATA - Shield contract address
**Returns:**:
- MERKLE_TRIE_NODE
**Example:**:| -| BRPC8| **# getCount**
**Description:** Gets count of a tree at the given 'address'.
**jsonrpc:** baseline_getRoot
**Caveats:** only works if the contract is tracked, otherwise
**Returns:** an error
**Parameters:**
- DATA - Shield contract address
**Returns:**:
- MERKLE_TRIE_NODE
**Example:**:| -| BRPC9|**# getSiblings**
**Description:** Retrieves siblings path/proof of the given leaf index.
**jsonrpc:** baseline_getSiblings
**Caveats:** only works if the contract is tracked, otherwise
**Returns:** an error
**Parameters:**
- DATA - address of the Shield contract
- QUANTITY - leaf index to prove
**Returns:**:
- Array<MERKLE_TRIE_NODE> - siblings path
**Example:**:| -| BRPC10|**# verify**
**Description:** Verifies a sibling path for a given root and leaf at the given shield contract address. .
**jsonrpc:** baseline_verify
**Caveats:** only works if the contract is tracked, otherwise
**Returns:** an error
**Parameters:**
- DATA - address of the Shield contract
- DATA - root node hash
- DATA - hash of the leaf node to be verified
- Array<DATA> - siblings path/proof
**Returns:**:
- bool - verification result
**Example:**:| -| BRPC11|**# verifyAndPush**
**Description:** .
**jsonrpc:** baseline_verify
**Caveats:** generates and sends a transaction which only affects the state after being included in a block
**Parameters:**
- DATA - address of the transaction sender
- DATA - address of the Shield contract
- Array<DATA> - proof data
- Array<DATA> - public inputs
- DATA - commitment
**Returns:**:
- DATA - transaction hash
**Example:**:| -| BRPC12 | **# deploy**
**Description:** Deploys a contract with the given 'contract type'. Requires the account to be unlocked.
**jsonrpc:** baseline_deploy
**Caveats:** Optional and only used for dev/testing
**Parameters:**
- DATA - address of the deploying transaction sender
- string - type of the contract to be deployed
**Returns:**: -
**Example:**:| -| BRPC13 | **# deployBytecode**
**Description:** Deploys a contract with the given bytecode. Requires the account to be unlocked.
**jsonrpc:** baseline_deployBytecode
**Caveats:** Optional and only used for dev/testing
**Parameters:**
- DATA - address of the deploying transaction sender
- string - type of the contract to be deployed
**Returns:**: -
**Example:**:| - -### 3.4.2 IBlockchainService - - - -## 3.5 Privacy - -Describes interfaces(s) providing functions to implement and manage private transactions.\ -IZKSnarkCircuitProvider\ -IZKSnarkCompilationArtifacts - -## 3.6 Persistence - -Describes interface(s) providing functions to store, query and update data.(sub and unsub ?)\ -### 3.6.1 IPersistenceService - -## 3.7 API Metadata - -Describes the object providing metadata information about the API (example: title, description, terms of service, contact, license,version) - -------- - -# 4 Data Model - -## 4.1 Org Management - -| Requirement ID | Requirement | -| :--- | :--- | -| ORGM1|**#Workgroup**
**id:**
**createdAt:**
**networkId:**
**userId:**
**name**:
**description:**
**type:**
**config:**
**hidden:**| -| ORGM2|**#Organization**
{id, createdAt, name, userId, description, metadata}| -| ORGM3|**#User**
{id, createdAt, name, firstName, lastName, email, permissions}\| -| ORGM4|**#OrgRegistry**
| - -## 4.1.1 Examples - -### 4.1.1.1 Workgroup - - - -``` -Workgroup { - id: '5bb63fd0-27f8-43f5-8275-14fe2891f14e', - createdAt: '2020-11-05T14:34:04.3478365Z', - networkId: '66d44f30-9092-4182-a3c4-bc02736d6ae5', - userId: 'e021eca9-17cc-4598-a513-c84b05c15270', - name: 'baseline workgroup', - description: null, - type: null, - config: { - webhook_secret: 'd6bf3a9f92344ea9b5ee29bd164060a9' - }, - hidden: false -} -``` - - - -### 4.1.1.2 Organization - - - -``` -Organization { - id: '440988f7-8f24-4dd8-bea0-8f103caa2fd5', - createdAt: '2020-11-05T14:35:26.4838047Z', - name: 'Bob Corp', - userId: 'e021eca9-17cc-4598-a513-c84b05c15270', - description: null, - metadata: { messaging_endpoint: 'nats://localhost:4224' } -} - - -``` - - - -## 4.2.3 User - - -``` -User { - id: '', - -} -``` - - - - -## 4.2.4 OrgRegistry - - -## 4.2 Messaging - -## 4.2.1 Examples - -``` -export enum Opcode { - Baseline = 'BLINE', // workflow-specific - Join = 'JOIN', // join workgroup - Ping = 'PING', - Pong = 'PONG', - Proof = 'PROOF', // generate proof - Verify = 'VRFY', // idempotent proof verification -}export enum PayloadType { - Binary = 0x0, - Text = 0x1, -}export type Message = { - opcode: Opcode; // up to 40 bits - sender: string, // up to 336 bits - recipient: string; // up to 336 bits - shield: string; // up to 336 bits - identifier: string; // up to 288 bits (i.e., UUIDv4 circuit/workflow identifier) - signature: string; // 512 bits - type: PayloadType; // 1 bit - payload: Buffer; // arbitrary length -} - -``` - -## 4.3 Security - -| Requirement ID | Requirement | -| :--- | :--- | -| SEC1|**#Vault**
{id, createAt, name, description}| -| SEC2|**#Key**
{id, createAt, vaultId, type, usage, spec, name, description, publicKey}| - - -Identity/authentication/authorization\ -Cryptography - curves, hash functions\ -audit - -## 4.3.1 Examples -``` -Vault { - id: 'f04e7222-bc86-47a4-a960-3be7e0a06995', - createdAt: '2020-11-05T14:39:35.088114Z', - name: 'Alice Corp vault', - description: 'default organizational keystore' -} - -Key { - id: '89c32eea-d522-4780-84bc-7c29de9f5cf1', - createdAt: '2020-11-05T14:39:37.7093941Z', - vaultId: 'f04e7222-bc86-47a4-a960-3be7e0a06995', - type: 'asymmetric', - usage: 'sign/verify', - spec: 'secp256k1', - name: 'Alice Corp secp256k1 keypair', - description: 'Alice Corp secp256k1 keypair', - address: '0x5AE7032d4E3eC2215474988e9831D45C793b2A0f', - publicKey: '0x049bd97593e08d40d77426d73a1f5ce2dbd184f58e48bee417577dcefcb6eab736dd06128a1eba69695af700bb1fcc5f0baa5e00ef597ebf2a0e2aaf2f8099c73c' -} - -``` - - -## 4.4 Agreement Execution - -Workflow {}\ -Worstep {} - - -## 4.5 Privacy - -## 4.6 Persistence - - - -------- - -# 5 Security Considerations - - - -------- - -# 6 Conformance - - - -------- - -# Appendix A. References - -This appendix contains the normative and informative references that are used in this document. Any normative work cited in the body of the text as needed to implement the work product must be listed in the Normative References section below. Each reference to a separate document or artifact in this work must be listed here and must be identified as either a Normative or an Informative Reference. Normative references are specific (identified by date of publication and/or edition number or version number) and Informative references are either specific or non-specific. - -While any hyperlinks included in this appendix were valid at the time of publication, OASIS cannot guarantee their long-term validity. - -(Note - Reference sources: - -For references to IETF RFCs, use the approved citation formats at: -http://docs.oasis-open.org/templates/ietf-rfc-list/ietf-rfc-list.html. - -For references to W3C Recommendations, use the approved citation formats at: -http://docs.oasis-open.org/templates/w3c-recommendations-list/w3c-recommendations-list.html. - -Remove this note before submitting for publication.) - - -## A.1 Normative References - -The following documents are referenced in such a way that some or all of their content constitutes requirements of this document. - - - -------- - -# Appendix B. ABC - -------- - -# Appendix C. Acknowledgments - - -## C.1 Special Thanks - - - -Substantial contributions to this document from the following individuals are gratefully acknowledged: - -Participant Name, Affiliation or "Individual Member" - -## C.2 Participants - - - -The following individuals have participated in the creation of this specification and are gratefully acknowledged: - -**Project-name OP Members:** - -| First Name | Last Name | Company | -| :--- | :--- | :--- | -x | x| Something Networks -x | x | Company B -x | x | Mini Micro -x | x | Big Networks - -------- - -# Appendix D. Revision History - -Revisions made since the initial stage of this numbered Version of this document may be tracked here. - -If revision tracking is handled in another system like github, provide a link to it instead of using this table, if desired. - -| Revision | Date | Editor | Changes Made | -| :--- | :--- | :--- | :--- | -| baseline-api-v1.0-psd01 | yyyy-mm-dd | Editor Name | Initial working draft | - - -------- - -# Appendix F. Notices - - - - -Copyright © OASIS Open 2020. All Rights Reserved. - -All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full [Policy](https://www.oasis-open.org/policies-guidelines/ipr) may be found at the OASIS website. - -This specification is published under the [CC0 1.0 Universal (CC0 1.0)](http://creativecommons.org/publicdomain/zero/1.0/) license. Portions of this specification are also provided under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). - -All contributions made to this project have been made under the [OASIS Contributor License Agreement (CLA)](https://www.oasis-open.org/policies-guidelines/open-projects-process#individual-cla-exhibit). - -For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the [Open Projects IPR Statements](https://github.com/oasis-open-projects/administration/blob/master/IPR_STATEMENTS.md) page. - -This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Open Project (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English. - -The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns. - -This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. OASIS AND ITS MEMBERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THIS DOCUMENT OR ANY PART THEREOF. - -As stated in the OASIS IPR Policy, the following three paragraphs in brackets apply to OASIS Standards Final Deliverable documents (Project Specifications, OASIS Standards, or Approved Errata). - -\[OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Standards Final Deliverable, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Open Project that produced this deliverable.\] - -\[OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this OASIS Standards Final Deliverable by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Open Project that produced this OASIS Standards Final Deliverable. OASIS may include such claims on its website, but disclaims any obligation to do so.\] - -\[OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this OASIS Standards Final Deliverable or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Open Project can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Standards Final Deliverable, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.\] - -The name "OASIS" is a trademark of [OASIS](https://www.oasis-open.org/), the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see https://www.oasis-open.org/policies-guidelines/trademark for above guidance. diff --git a/docs/specs/api/images/image_1.png b/docs/specs/api/images/image_1.png deleted file mode 100644 index 1c86050d7..000000000 Binary files a/docs/specs/api/images/image_1.png and /dev/null differ diff --git a/docs/specs/api/styles/markdown-styles-v1.7.3.css b/docs/specs/api/styles/markdown-styles-v1.7.3.css deleted file mode 100644 index 0feab0bbd..000000000 --- a/docs/specs/api/styles/markdown-styles-v1.7.3.css +++ /dev/null @@ -1,82 +0,0 @@ -/* OASIS specification styles for HTML generated from Markdown or similar sources */ -/* usually used after basic w3.css */ -/* Paul Knight 2018-09-27 */ -/* pk 2018-10-01 - v1.2 reduced section header and title (h*) font sizes */ -/* pk 2018-10-02 - v1.3 added right margin; allowed text wrapping in code blocks and scrolling for overflowing text */ -/* pk 2018-10-19 - v1.4 added display:inline to avoid page-wide background coloring */ -/* pk 2018-10-25 - v1.5 added use of
as citation tag for References section or elsewhere */ -/* pk 2018-10-26 - v1.5.1 (experimental) and v1.6 added use of
as a page break when generating PDF from the HTML */ -/* pk 2018-11-14 - v1.6.1 - lighter gray background color for code blocks */ -/* pk 2019-02-18 - v1.7 - Use Liberation Sans and Liberation Mono fonts if possible */ -/* pk 2019-02-18 - v1.7.1 (experimental) changed px to pt (and reduced numbers) for fonts and tables; added bigtitle style */ -/* pk 2019-05-23 - v1.7.2 (based on 1.7.1) changed monospace "code" font to Courier New */ -/* pk 2019-08-01 - v1.7.3 substitute PostScript name for fonts (LiberationSans for "Liberation Sans" and CourierNew for "Courier New") to address a flaw in "wkhtmltopdf" which rendered all text as bold. Changed "bigtitle" to "h1big"*/ - -body { - margin-left: 3pc; - margin-right: 3pc; - font-family: LiberationSans, Arial, Helvetica, sans-serif; - font-size:12pt; - line-height:1.2 - } - -html{overflow-x:auto} - - /* styles for section headings - levels 1-5 (maybe include heading1, etc. later) */ -h1{font-size:18pt}h2{font-size:14pt}h3{font-size:13pt}h4{font-size:12pt}h5{font-size:11pt} -h1big{font-size: 24pt} - /* h1big is usually applied manually to the main title, by changing the "h1" tags */ -h1,h2,h3,h4,h5,h1big{font-family: LiberationSans, Arial, Helvetica, sans-serif;font-weight: bold;margin:8pt 0;color: #446CAA} - /* style for h6, for use as Reference tag */ -h6{font-size:12pt; line-height:1.0} -h6{font-family: LiberationSans, Arial, Helvetica, sans-serif;font-weight: bold;margin:0pt;} - /* not needed - can just use brackets in the label itself */ - /* h6::before {content: "["} */ - /* h6::after {content: "]"} */ - - /* style for hr to insert a page break before each ruled line (generated in markdown by 3 or more hyphens alone on a line) */ -hr{page-break-before: always;} - - -/* Table styles - bordered with option for striped */ -table { - border-collapse: collapse; -} - -table { - border-collapse:collapse; - border-spacing:0; - width:100%; - display:table; - font-size:12pt; - margin-top: 6pt; - } - -table, th, td { - border: 1pt solid black; - padding:6pt 6pt; - text-align:left; - vertical-align:top; -} -th { - color:#ffffff; - background-color:#1a8cff; - } - /* "table-striped" tag is not generated by pandoc - add manually in HTML if wanted */ -.table-striped tbody tr:nth-child(even){background-color:#d6f3ff} - -/* style for code blocks */ -code,kbd,pre,samp{ - font-family:CourierNew, monospace; - font-size:1em; - white-space: pre-wrap; - background-color:#e8e8e8; - display:inline; - } - -/* offset block quote */ -blockquote { - background-color:#e8e8e8; - display:inline; - } - diff --git a/docs/specs/core/README.md b/docs/specs/core/README.md deleted file mode 100644 index 70ceb674a..000000000 --- a/docs/specs/core/README.md +++ /dev/null @@ -1,59 +0,0 @@ -# Baseline Protocol Specifications - -![Baseline Logo](https://raw.githubusercontent.com/ethereum-oasis/baseline/master/docs/assets/baseline-logo/Web/examples/PNGs/horizontal/baselineHorizontal-Logo-FullColor.png) - -*Read the full documentation [here at docs.baseline-protocol.org](https://docs.baseline-protocol.org/).* -*Join our [Slack workspace](https://communityinviter.com/apps/ethereum-baseline/join-us), [Discord channel](https://discord.com/invite/NE8AYD7), [Telegram channel](https://t.me/baselineprotocol) and follow us on [Twitter](https://twitter.com/baselineproto) for Baseline news and updates!* - -## The Baseline CORE Specification - -The document describes the minimal set of business and technical prerequisites, functional and non-functional requirements, together with a reference architecture that when implemented ensures that two or more systems of record can synchronize their system state over a permissionless public Distributed Ledger Technology (DLT) network. - -## Status - -The Baseline CORE specification is currently work in progress. - -## Components - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ComponentComponent Description
Baseline APIReference Baseline API Spec
CommunicationDescribes communication between systems of record and systems of record and public common frame of reference through message queues.
Privacy & ConfidentialityDescribes mechanisms to ensure counterparties confidentiality and shielded private transactions.
Agreement ExecutionDescribes the functionalities, events and terms required for baselining.
GovernanceDescribes the required functionalities to implement governance processes at every functional layer of the Baseline specification such as software change control.
Securitiy ConsiderationsDescribes security topics that should be important in Baseline implementations but that are NOT requirements.
ConformanceDescribes the conformance clauses and tests required to achieve baseline compliant implementations.
- -## License - -All contribution in this repo is released under the CC0 1.0 Universal public domain dedication. For the full license text, refer to [LICENSE](https://github.com/ethereum-oasis/baseline/blob/master/LICENSE). - -## Contributions - -To participate in the evolution of Baseline via the specs process, please see our [Contributors Guidelines](https://docs.baseline-protocol.org/community/contributors). \ No newline at end of file diff --git a/docs/specs/core/baseline-core-v1.0-psd01.md b/docs/specs/core/baseline-core-v1.0-psd01.md deleted file mode 100644 index f4bdd73f4..000000000 --- a/docs/specs/core/baseline-core-v1.0-psd01.md +++ /dev/null @@ -1,479 +0,0 @@ - -![OASIS Logo](http://docs.oasis-open.org/templates/OASISLogo-v2.0.jpg) -------- - -# Baseline Core Version 1.0 - -## Project Specification Working Draft - -## 29 September 2020 - - - -#### Open Project: -[Baseline, part of the Ethereum OASIS Open Project](https://www.baseline-protocol.org/) - -#### Project Chair: -John Wolpert (john.wolpert@mesh.xyz), [ConsenSys](https://consensys.net/) - -#### Editors: -Anais Ofranc (aofranc@consianimis.com), [Consianimis](https://www.consianimis.com/) \ -Andreas Freund (a.freundhaskel@gmail.com) \ -Brian Chamberlain (brian.chamberlain@consensys.net), [ConsenSys](https://consensys.net/) \ -Charles ‘Chaals’ Nevile (charles.nevile@consensys.net), [ConsenSys](https://entethalliance.org/) \ -Daniel Norkin (daniel.norkin@envisionblockchain.com), [Envision Blockchain](https://envisionblockchain.com/) - - - -#### Related work: - - - -This specification is related to: \ -_Baseline API and Data Model version 1.0_ - https://github.com/ethereum-oasis/baseline/tree/master/docs/specs/api - - -#### Abstract: -This document describes the minimal set of business and technical prerequisites, functional and non-functional requirements, together with a reference architecture that when implemented ensures that two or more systems of record can synchronize their system state over a permissionless public Distributed Ledger Technology (DLT) network. - -#### Status: -This document is under active development and implementers are advised against implementing the specification unless they are directly involved with the Baseline TC team. - - - -Comments on this work can be provided by opening issues in the project repository or by sending email to the project’s public comment list baseline@lists.oasis-open-projects.org. - - -#### Key words: -The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [[RFC2119](#rfc2119)] and [[RFC8174](#rfc8174)] when, and only when, they appear in all capitals, as shown here. - -#### Citation format: -When referencing this specification the following citation format should be used: - -**[baseline-core-v1.0]** - -_Baseline Core Version 1.0_. Edited by Anais Ofranc. 29 September 2020. OASIS Project Specification Draft 01. https://docs.oasis-open.org/baseline/baseline-core/v1.0/psd01/baseline-core-v1.0-psd01.html. Latest stage: https://docs.oasis-open.org/baseline/baseline-core/v1.0/baseline-core-v1.0.html. - -------- - -## Notices -Copyright © OASIS Open 2020. All Rights Reserved. - -Distributed under the terms of the OASIS [IPR Policy](https://www.oasis-open.org/policies-guidelines/ipr). - -For complete copyright information please see the Notices section in the Appendix. - -------- - -# Table of Contents -[1 Introduction](#1-introduction) \ -    [1.1 Overview](#11-overview) \ -    [1.2 Glossary](#12-glossary) \ -    [1.3 Typographical Conventions](#13-typographical-conventions) \ -[2 Design and Architecture](#2-design-and-architecture) \ -[3 API and Data Model](#3-api-and-data-model) \ -[4 Communication](#4-communication) \ -    [4.1 Authentication and Authorization](#41-authentication-and-authorization) \ -    [4.2 Message Delivery](#42-message-delivery) \ -    [4.3 Performance](#43-performance) \ -[5 Privacy and Confidentiality](#5-privacy-and-confidentiality) \ -    [5.1 Privacy](#51-privacy) \ -    [5.2 Confidentiality](#52-confidentiality) \ -[6 Agreement Execution](#6-agreement-execution) \ -    [6.1 Business Logic Development](#61-business-logic-development) \ -    [6.2 Business Logic Execution](#62-business-logic-execution) \ -    [6.3 Performance](#63-performance) \ -[7 Governance](#7-governance) \ -    [7.1 Governance Model](#71-governance-model) \ -[8 Security Considerations](#8-security-considerations) \ -    [8.1 Data Privacy](#81-data-privacy) \ -    [8.2 Production readiness](#82-production-readiness) \ -[9 Conformance](#9-conformance) \ -    [9.1 Conformance Targets](#91-conformance-targets) \ -    [9.2 Conformance Levels](#92-conformances-levels)\ -    [9.3 Interoperability](#93-interoperability)\ -[Appendix A. Acknowledgments]()\ -[Appendix B. Revision History]() - - - -------- - -# 1 Introduction - - -## 1.1 Overview - - -## 1.2 Glossary - -- Definitions of terms -- Acronyms and abbreviations - -## 1.3 Typographical Conventions - -- Naming conventions -- Font colors and styles -- Typographic conventions - - -------- - -# 2 Design and Architecture - - -------- - -# 3 API and Data Model - - -------- - -# 4 Communication - -This section describes the logical architecture (presented as two abstract services - Authentication & Authorization and Message Delivery) that allows parties to send and receive messages securely. - -## 4.1 Authentication and Authorization - -Describes the requirements for the Authentication service responsible for establishing and maintaining the connection between verified parties. - -| Requirement ID | Requirement | -| :--- | :--- | -| COM1 | something MUST something | -| COM2 | something SHOULD something | - -## 4.2 Message Delivery - -Describes the requirements for the Delivery service responsible for exchanging messages between verified parties. - -| Requirement ID|Requirement | -| :--- | :--- | -| COM3 | MUST implement IMessagingService interface to interact with verified parties. | -| COM4 | MUST implement pub-sub pattern. | -| COM5 | MUST implement XYZ Protocol Messages (types, formats, queues, inbound, outbound). | -| COM6 | Automated message validation | -| COM7 | Messaging Endpoints - SHOULD be distinct from system of record. | - -## 4.3 Performance - -Describes the performance requirements for the Communication component. - -| Requirement ID|Requirement | -| :--- | :--- | -| COM8 | Durable messaging | -| COM9 | Persistent messaging| -| COM10 | Latency | -| COM11 | Fault-tolerance | -| COM12 | Scalability | - - -------- - -# 5 Privacy and Confidentiality - -This section describes mechanisms to ensure counterparties confidentiality and shielded private transactions. - -## 5.1 Privacy -Describes mechanisms ensuring that only information relevant to the transaction and pre-agreed by verified parties is used to its purpose. - -| Requirement ID|Requirement | -| :--- | :--- | -| PRICON1 | something MUST something | -| PRICON2 | something SHOULD something | - - -## 5.2 Confidentiality - -Describes the mechanisms ensuring that other parties (i.e parties outside of transaction) are prevented from accessing data that they are not authorized to access. - -| Requirement ID|Requirement | -| :--- | :--- | -| PRICON3 | something MUST something | -| PRICON4 | something SHOULD something | - -------- - -# 6 Agreement Execution - -## 6.1 Business Logic Development - -Describes the requirements for the development of business rules that define what and how workflows are executed. - -| Requirement ID|Requirement | -| :--- | :--- | -| AGEXEC1 | IBaselineRPC | -| AGEXEC2| Shared agreement: up to each workgroup to agree on business logic | -| AGEXEC3| Shielding: up up to each workgroup to determine a suitable shielding mechanism. | - -## 6.2 Business Logic Execution - -Describes the mechanisms supporting the execution of the agreed business logic. - - -| Requirement ID|Requirement | -| :--- | :--- | -| AGEXEC4 | Workflows, worksteps - business rules chaining and sequenced execution | -| AGEXEC5| Deterministic result - given a set of arguments and a state of the ledger, execution of business logic must produce the same result. | -| AGEXEC6| Event-driven | -| AGEXEC7| On-chain/ DTL execution mode| - -## 6.3 Performance - -Describes the performance requirements for the Agreement Execution component. - -| Requirement ID|Requirement | -| :--- | :--- | -| AGEXEC8 | Processing/Finality time | -| AGEXEC9| Execution/Process monitoring | - -------- - -# 7 Governance -Describes the required functionalities to implement governance processes at every functional layer of the Baseline specification. - - -## 7.1 Governance Model - -| Requirement ID|Requirement | -| :--- | :--- | -| GOV1 | Change Control - requirements for introducing change in a controlled and coordinated manner for each functional layer. | -| GOV2| Execution/Process monitoring | - - -## 7.2 Audit - -Describes the requirements for audit activities. - - -| Requirement ID|Requirement | -| :--- | :--- | -| GOV3 |Internal audit | -| GOV4| External audit | - - -## 7.3 Monitoring & Reporting - -Describes the requirements for monitoring and reporting on operations for each functional layer. - -| Requirement ID|Requirement | -| :--- | :--- | -| GOV5 | something MUST something | -| GOV6| something SHOULD something | - -------- - -# 8 Security Considerations - - -Describes security topics that should be important in Baseline implementations but that are NOT requirements. - -## 8.1 Data Privacy - -Provides a list of considerations related to data privacy. - -The standard does not set any requirements for compliance to jurisdiction legislation/regulations, responsibility of the implementer to comply to applicable data privacy laws. - -## 8.2 Production Readiness - -Provides a list of considerations related to the use of underlying protocols/applications/tools etc. - -The standard does not set any requirements for the use of specific applications/tools/libraries etc. -Examples included in standard to be non-normative. -The implementer should perform due diligence when selecting tools, libraries etc. - - - - - -------- - -# 9 Conformance - - -Describes the conformance clauses and tests required to achieve baseline compliant implementations. - -## 9.1 Conformance Targets - -Defines entities and implementations subject to conformance. - - -## 9.2 Conformance Levels - -Defines conformance levels and their conformance clauses. - -## 9.3 Interoperability - - - -------- - -# Appendix A. References - -This appendix contains the normative and informative references that are used in this document. Any normative work cited in the body of the text as needed to implement the work product must be listed in the Normative References section below. Each reference to a separate document or artifact in this work must be listed here and must be identified as either a Normative or an Informative Reference. Normative references are specific (identified by date of publication and/or edition number or version number) and Informative references are either specific or non-specific. - -While any hyperlinks included in this appendix were valid at the time of publication, OASIS cannot guarantee their long-term validity. - -(Note - Reference sources: - -For references to IETF RFCs, use the approved citation formats at: -http://docs.oasis-open.org/templates/ietf-rfc-list/ietf-rfc-list.html. - -For references to W3C Recommendations, use the approved citation formats at: -http://docs.oasis-open.org/templates/w3c-recommendations-list/w3c-recommendations-list.html. - -Remove this note before submitting for publication.) - - -## A.1 Normative References - -The following documents are referenced in such a way that some or all of their content constitutes requirements of this document. - - -## A.2 Informative References - -------- - -# Appendix B. ABC - - -------- - -# Appendix C. Acknowledgments - -## C.1 Special Thanks - - - -Substantial contributions to this document from the following individuals are gratefully acknowledged: - -Participant Name, Affiliation or "Individual Member" - -## C.2 Participants - - - -The following individuals have participated in the creation of this specification and are gratefully acknowledged: - -**Project-name OP Members:** - -| First Name | Last Name | Company | -| :--- | :--- | :--- | -x | x | Something Networks -x | x | Company B -x | x | Mini Micro -x | x | Big Networks - -------- - -# Appendix D. Revision History - -Revisions made since the initial stage of this numbered Version of this document may be tracked here. - -If revision tracking is handled in another system like github, provide a link to it instead of using this table, if desired. - -| Revision | Date | Editor | Changes Made | -| :--- | :--- | :--- | :--- | -| baseline-core-v1.0-psd01 | 2020-09-29 | Anais Ofranc | Initial working draft | - -------- - -------- - -# Appendix F. Notices - - - - -Copyright © OASIS Open 2020. All Rights Reserved. - -All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full [Policy](https://www.oasis-open.org/policies-guidelines/ipr) may be found at the OASIS website. - -This specification is published under the [CC0 1.0 Universal (CC0 1.0)](http://creativecommons.org/publicdomain/zero/1.0/) license. Portions of this specification are also provided under the [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0). - -All contributions made to this project have been made under the [OASIS Contributor License Agreement (CLA)](https://www.oasis-open.org/policies-guidelines/open-projects-process#individual-cla-exhibit). - -For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the [Open Projects IPR Statements](https://github.com/oasis-open-projects/administration/blob/master/IPR_STATEMENTS.md) page. - -This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Open Project (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English. - -The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns. - -This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. OASIS AND ITS MEMBERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THIS DOCUMENT OR ANY PART THEREOF. - -As stated in the OASIS IPR Policy, the following three paragraphs in brackets apply to OASIS Standards Final Deliverable documents (Project Specifications, OASIS Standards, or Approved Errata). - -\[OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Standards Final Deliverable, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Open Project that produced this deliverable.\] - -\[OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this OASIS Standards Final Deliverable by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Open Project that produced this OASIS Standards Final Deliverable. OASIS may include such claims on its website, but disclaims any obligation to do so.\] - -\[OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this OASIS Standards Final Deliverable or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Open Project can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Standards Final Deliverable, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.\] - -The name "OASIS" is a trademark of [OASIS](https://www.oasis-open.org/), the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see https://www.oasis-open.org/policies-guidelines/trademark for above guidance. diff --git a/docs/specs/core/images/image_1.png b/docs/specs/core/images/image_1.png deleted file mode 100644 index 1c86050d7..000000000 Binary files a/docs/specs/core/images/image_1.png and /dev/null differ diff --git a/docs/specs/core/styles/markdown-styles-v1.7.3.css b/docs/specs/core/styles/markdown-styles-v1.7.3.css deleted file mode 100644 index 0feab0bbd..000000000 --- a/docs/specs/core/styles/markdown-styles-v1.7.3.css +++ /dev/null @@ -1,82 +0,0 @@ -/* OASIS specification styles for HTML generated from Markdown or similar sources */ -/* usually used after basic w3.css */ -/* Paul Knight 2018-09-27 */ -/* pk 2018-10-01 - v1.2 reduced section header and title (h*) font sizes */ -/* pk 2018-10-02 - v1.3 added right margin; allowed text wrapping in code blocks and scrolling for overflowing text */ -/* pk 2018-10-19 - v1.4 added display:inline to avoid page-wide background coloring */ -/* pk 2018-10-25 - v1.5 added use of
as citation tag for References section or elsewhere */ -/* pk 2018-10-26 - v1.5.1 (experimental) and v1.6 added use of
as a page break when generating PDF from the HTML */ -/* pk 2018-11-14 - v1.6.1 - lighter gray background color for code blocks */ -/* pk 2019-02-18 - v1.7 - Use Liberation Sans and Liberation Mono fonts if possible */ -/* pk 2019-02-18 - v1.7.1 (experimental) changed px to pt (and reduced numbers) for fonts and tables; added bigtitle style */ -/* pk 2019-05-23 - v1.7.2 (based on 1.7.1) changed monospace "code" font to Courier New */ -/* pk 2019-08-01 - v1.7.3 substitute PostScript name for fonts (LiberationSans for "Liberation Sans" and CourierNew for "Courier New") to address a flaw in "wkhtmltopdf" which rendered all text as bold. Changed "bigtitle" to "h1big"*/ - -body { - margin-left: 3pc; - margin-right: 3pc; - font-family: LiberationSans, Arial, Helvetica, sans-serif; - font-size:12pt; - line-height:1.2 - } - -html{overflow-x:auto} - - /* styles for section headings - levels 1-5 (maybe include heading1, etc. later) */ -h1{font-size:18pt}h2{font-size:14pt}h3{font-size:13pt}h4{font-size:12pt}h5{font-size:11pt} -h1big{font-size: 24pt} - /* h1big is usually applied manually to the main title, by changing the "h1" tags */ -h1,h2,h3,h4,h5,h1big{font-family: LiberationSans, Arial, Helvetica, sans-serif;font-weight: bold;margin:8pt 0;color: #446CAA} - /* style for h6, for use as Reference tag */ -h6{font-size:12pt; line-height:1.0} -h6{font-family: LiberationSans, Arial, Helvetica, sans-serif;font-weight: bold;margin:0pt;} - /* not needed - can just use brackets in the label itself */ - /* h6::before {content: "["} */ - /* h6::after {content: "]"} */ - - /* style for hr to insert a page break before each ruled line (generated in markdown by 3 or more hyphens alone on a line) */ -hr{page-break-before: always;} - - -/* Table styles - bordered with option for striped */ -table { - border-collapse: collapse; -} - -table { - border-collapse:collapse; - border-spacing:0; - width:100%; - display:table; - font-size:12pt; - margin-top: 6pt; - } - -table, th, td { - border: 1pt solid black; - padding:6pt 6pt; - text-align:left; - vertical-align:top; -} -th { - color:#ffffff; - background-color:#1a8cff; - } - /* "table-striped" tag is not generated by pandoc - add manually in HTML if wanted */ -.table-striped tbody tr:nth-child(even){background-color:#d6f3ff} - -/* style for code blocks */ -code,kbd,pre,samp{ - font-family:CourierNew, monospace; - font-size:1em; - white-space: pre-wrap; - background-color:#e8e8e8; - display:inline; - } - -/* offset block quote */ -blockquote { - background-color:#e8e8e8; - display:inline; - } - diff --git a/docs/tickets/provideclisetupwindows.md b/docs/tickets/provideclisetupwindows.md index e49293a9a..eb4f8db2b 100644 --- a/docs/tickets/provideclisetupwindows.md +++ b/docs/tickets/provideclisetupwindows.md @@ -1,40 +1,40 @@ -## Windows Instructions -Provided on: docs.provide.services -Windows Specifications: - -Edition Windows 10 Home -Version 1909 -Installed on 3/8/2020 -OS build 18363.1139 - -1. git clone git@github.com:provideplatform/provide-cli.git -cd provide-cli -mkdir -p ~go -Ensure your environment is setup correctly. -set GOPATH=$HOME/go -set "PATH=$GOPATH/bin" -You will probably want to add the above path exports to your ~/.zshrc or equivalent. -go build ./... -go install ./... - -rm ~\go\bin\prvd.exe -mv ~\go\bin\provide-cli.exe ~\go\bin\prvd.exe - -Authentication -Once you have completed the setup and installed the CLI, the next step is to authenticate yourself, so that you can begin to interact with the Provide CLI and start interacting with the Provide Stack. - -Create a new user if you have not already done so: - -prvd users create -Once that process is complete, you should authenticate: - -prvd authenticate -Enter your username and password: - -prvd organizations init -prvd organizations list -prvd api_tokens init --organization 04793d07-888e-4863-b6fa-17900e63f663 --offline-access -prvd baseline workgroups init -prvd baseline workgroups participants invite - +## Windows Instructions +Provided on: docs.provide.services +Windows Specifications: + +Edition Windows 10 Home +Version 1909 +Installed on 3/8/2020 +OS build 18363.1139 + +1. git clone git@github.com:provideplatform/provide-cli.git +cd provide-cli +mkdir -p ~go +Ensure your environment is setup correctly. +set GOPATH=$HOME/go +set "PATH=$GOPATH/bin" +You will probably want to add the above path exports to your ~/.zshrc or equivalent. +go build ./... +go install ./... + +rm ~\go\bin\prvd.exe +mv ~\go\bin\provide-cli.exe ~\go\bin\prvd.exe + +Authentication +Once you have completed the setup and installed the CLI, the next step is to authenticate yourself, so that you can begin to interact with the Provide CLI and start interacting with the Provide Stack. + +Create a new user if you have not already done so: + +prvd users create +Once that process is complete, you should authenticate: + +prvd authenticate +Enter your username and password: + +prvd organizations init +prvd organizations list +prvd api_tokens init --organization 04793d07-888e-4863-b6fa-17900e63f663 --offline-access +prvd baseline workgroups init +prvd baseline workgroups participants invite + Windows Instruction's Stop at Participating Organization page \ No newline at end of file diff --git a/examples/battleship/README.md b/examples/battleship/README.md index b5deb29d1..1911ca9c1 100644 --- a/examples/battleship/README.md +++ b/examples/battleship/README.md @@ -10,7 +10,7 @@ VS Code or any of your favorite IDE [Docker compose](https://docs.docker.com/compose/install/ ) [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git ) -Once you have these installed, clone the official repo [Baseline repo](https://github.com/eea-oasis/baseline) and have it added to your local working directory +Once you have these installed, clone the official repo [Baseline repo](https://github.com/ethereum-oasis-op/baseline) and have it added to your local working directory Navigate to the following path ``` diff --git a/examples/battleship/server/baseline/privacy/README.md b/examples/battleship/server/baseline/privacy/README.md index eb4287c9a..c9dc3c40c 100644 --- a/examples/battleship/server/baseline/privacy/README.md +++ b/examples/battleship/server/baseline/privacy/README.md @@ -1,4 +1,4 @@ # Battleship Circuit -This circuit is simplifed version of https://github.com/tommymsz006/zkbattleship-circuit/blob/master/circom/battleship_sha256.circom. +This circuit is simplifed version of https://github.com/tommymsz006/zkbattleship-circuit/blob/main/circom/battleship_sha256.circom. Also, this version is using latest circom and snarkjs. To generate wasm, zkey and verifier contract follow steps here https://github.com/iden3/snarkjs. \ No newline at end of file diff --git a/examples/battleship/server/baseline/privacy/circuit.circom b/examples/battleship/server/baseline/privacy/circuit.circom index cb1089630..031f21f34 100644 --- a/examples/battleship/server/baseline/privacy/circuit.circom +++ b/examples/battleship/server/baseline/privacy/circuit.circom @@ -1,7 +1,7 @@ pragma circom 2.0.0; include "./node_modules/circomlib/circuits/pedersen.circom"; -// simplified version of battleship circuit https://github.com/tommymsz006/zkbattleship-circuit/blob/master/circom/battleship_sha256.circom +// simplified version of battleship circuit https://github.com/tommymsz006/zkbattleship-circuit/blob/main/circom/battleship_sha256.circom // with only one ship, slightly adapted to work with latest version circom template Battleship() { diff --git a/examples/bpi-interop/README.md b/examples/bpi-interop/README.md index f8ed9e88f..27090b507 100644 --- a/examples/bpi-interop/README.md +++ b/examples/bpi-interop/README.md @@ -1,6 +1,6 @@ # Baseline Protocol - BPI Interoperability -This is the workspace of the Baseline Interop WG to deliver on the [2023 Baseline Protocol Interoperability roadmap item](https://github.com/eea-oasis/baseline-grants/issues/101). +This is the workspace of the Baseline Interop WG to deliver on the [2023 Baseline Protocol Interoperability roadmap item](https://github.com/ethereum-oasis-op/baseline-grants/issues/101). The WG meets every Friday at 7:30 am PST / 10:30 am EST / 15:30 GMT / 19:00 IST. Please, use this [Zoom link](https://us02web.zoom.us/j/85004523244?pwd=Y0U3N1gxYittSUNYZEZPZGkrQXZDQT09) to join the meetings. diff --git a/examples/bpi-interop/schemas/r140-bankstateobject.json b/examples/bpi-interop/schemas/r140-bankstateobject.json index 071f62276..0b148591b 100644 --- a/examples/bpi-interop/schemas/r140-bankstateobject.json +++ b/examples/bpi-interop/schemas/r140-bankstateobject.json @@ -1,7 +1,7 @@ { - "$id": "https://github.com/eea-oasis/baseline/blob/main/examples/bpi-interop/schemas/r140-bankstateobject.json", + "$id": "https://github.com/ethereum-oasis-op/baseline/blob/main/examples/bpi-interop/schemas/r140-bankstateobject.json", "$schema": "https://json-schema.org/draft-07/schema#", - "$comment": "{\"term\": \"r140-bankstateobject\", \"@id\": \"https://github.com/eea-oasis/baseline#r140-bankstateobject\"}", + "$comment": "{\"term\": \"r140-bankstateobject\", \"@id\": \"https://github.com/ethereum-oasis-op/baseline#r140-bankstateobject\"}", "title": "BankStateObject", "description": "Bank State Object", "type": "object", diff --git a/examples/bpi-interop/schemas/r141-syncadvancepredicate.json b/examples/bpi-interop/schemas/r141-syncadvancepredicate.json index 6b55f274e..fafebe410 100644 --- a/examples/bpi-interop/schemas/r141-syncadvancepredicate.json +++ b/examples/bpi-interop/schemas/r141-syncadvancepredicate.json @@ -1,9 +1,9 @@ { "$schema": "https://json-schema.org/draft-07/schema#", - "$id": "https://github.com/eea-oasis/baseline/blob/main/examples/bpi-interop/schemas/r141-syncadvancepredicate.json", + "$id": "https://github.com/ethereum-oasis-op/baseline/blob/main/examples/bpi-interop/schemas/r141-syncadvancepredicate.json", "$comment": { "term": "r141-syncadvancepredicate", - "@id": "https://github.com/eea-oasis/baseline#r141-syncadvancepredicate" + "@id": "https://github.com/ethereum-oasis-op/baseline#r141-syncadvancepredicate" }, "title": "syncadvancepredicate", "description": "BPI State Synchronization and Advancement Predicate", @@ -230,7 +230,7 @@ "required": ["predicate", "input", "output"] }, "bankStateObject": { - "$ref": "https://github.com/eea-oasis/baseline/blob/main/examples/bpi-interop/schemas/r140-bankstateobject.json" + "$ref": "https://github.com/ethereum-oasis-op/baseline/blob/main/examples/bpi-interop/schemas/r140-bankstateobject.json" }, "environment": { "type": "array", @@ -272,7 +272,7 @@ }, "definitions": { "BankStateObject": { - "$ref": "https://github.com/eea-oasis/baseline/blob/main/examples/bpi-interop/schemas/r140-bankstateobject.json" + "$ref": "https://github.com/ethereum-oasis-op/baseline/blob/main/examples/bpi-interop/schemas/r140-bankstateobject.json" }, "Environment": { "type": "object", diff --git a/examples/bpi-monolith-test-suite/package.json b/examples/bpi-monolith-test-suite/package.json index a5b0cc2bd..523c7e189 100644 --- a/examples/bpi-monolith-test-suite/package.json +++ b/examples/bpi-monolith-test-suite/package.json @@ -8,14 +8,14 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/eea-oasis/baseline.git" + "url": "git+https://github.com/ethereum-oasis-op/baseline.git" }, "author": "", "license": "ISC", "bugs": { - "url": "https://github.com/eea-oasis/baseline/issues" + "url": "https://github.com/ethereum-oasis-op/baseline/issues" }, - "homepage": "https://github.com/eea-oasis/baseline#readme", + "homepage": "https://github.com/ethereum-oasis-op/baseline#readme", "devDependencies": { "@types/chai": "^4.2.22", "@types/crypto-js": "^4.0.2", diff --git a/examples/bpi-monolith-test-suite/readme.md b/examples/bpi-monolith-test-suite/readme.md index ff44108ea..aee768c68 100644 --- a/examples/bpi-monolith-test-suite/readme.md +++ b/examples/bpi-monolith-test-suite/readme.md @@ -18,4 +18,4 @@ At the moment, there are no open-source BPIs that can serve for core dev onboard ## How to participate -Team is working on creating a set of small, atomic and independent tasks that can be picked up by a dev trying to get into the protocol. You can see the current list of tasks [here](https://github.com/eea-oasis/baseline/projects/2) and express your interest in the [Baseline Slack](https://join.slack.com/t/ethereum-baseline/shared_invite/zt-d6emqeci-bjzBsXBqK4D7tBTZ40AEfQ) #devs channel. \ No newline at end of file +Team is working on creating a set of small, atomic and independent tasks that can be picked up by a dev trying to get into the protocol. You can see the current list of tasks [here](https://github.com/ethereum-oasis-op/baseline/projects/2) and express your interest in the [Baseline Slack](https://join.slack.com/t/ethereum-baseline/shared_invite/zt-d6emqeci-bjzBsXBqK4D7tBTZ40AEfQ) #devs channel. \ No newline at end of file diff --git a/examples/bri-2/zkp-mgr/Dockerfile b/examples/bri-2/zkp-mgr/Dockerfile deleted file mode 100644 index 11d583418..000000000 --- a/examples/bri-2/zkp-mgr/Dockerfile +++ /dev/null @@ -1,15 +0,0 @@ -FROM golang:1.15-alpine AS builder - -RUN mkdir -p /go/src/github.com/ethereum-oasis/baseline/zkp-mgr -COPY . /go/src/github.com/ethereum-oasis/baseline/zkp-mgr/ -WORKDIR "/go/src/github.com/ethereum-oasis/baseline/zkp-mgr" -RUN go mod tidy -RUN CGO_ENABLED=0 GOOS=linux go build -a -o zkp-mgr src/*.go -RUN mv /go/src/github.com/ethereum-oasis/baseline/zkp-mgr /root/zkp-mgr - -FROM golang:1.15-alpine -# RUN apk --no-cache add ca-certificates -WORKDIR /root/ -COPY --from=builder /root/zkp-mgr . -CMD ["./zkp-mgr"] -EXPOSE 8080 \ No newline at end of file diff --git a/examples/bri-3/README.md b/examples/bri-3/README.md index f313eb50f..60d69c0bc 100644 --- a/examples/bri-3/README.md +++ b/examples/bri-3/README.md @@ -1,6 +1,6 @@ ## Description -BRI-3 is a simple reference implemenation of the baseline standard, developed under [grant 85](https://github.com/eea-oasis/baseline-grants/issues/85). +BRI-3 is a simple reference implemenation of the baseline standard, developed under [grant 85](https://github.com/ethereum-oasis-op/baseline-grants/issues/85). This reference implementation is being built from scratch and will contain a limited set of features. It will serve the following purposes: diff --git a/examples/bri-3/docs/dids/did-authentication.md b/examples/bri-3/docs/dids/did-authentication.md index d16e840f4..a63240284 100644 --- a/examples/bri-3/docs/dids/did-authentication.md +++ b/examples/bri-3/docs/dids/did-authentication.md @@ -45,6 +45,6 @@ where 5. BpiOperator receives the request, verifies the token, and, if successful, routes the request to the target service. If the token verification fails (e.g. expiration), a failure message is generated, and the request is not routed to its target service. ## Reference -1. [PR #606](https://github.com/eea-oasis/baseline/pull/606) +1. [PR #606](https://github.com/ethereum-oasis-op/baseline/pull/606) 2. [DID authentication](https://rsksmart.github.io/rif-identity-docs/ssi/specs/did-auth.html#how-to-send-tokens) 3. [W3C Decentralized Identifiers (DIDs) v1.0](https://www.w3.org/TR/did-core/#dfn-did-subjects) \ No newline at end of file diff --git a/examples/bri-3/package-lock.json b/examples/bri-3/package-lock.json index baf774b66..42bef71fe 100644 --- a/examples/bri-3/package-lock.json +++ b/examples/bri-3/package-lock.json @@ -2155,7 +2155,7 @@ "@ucast/mongo2js": "^1.3.0" }, "funding": { - "url": "https://github.com/stalniy/casl/blob/master/BACKERS.md" + "url": "https://github.com/stalniy/casl/blob/main/BACKERS.md" } }, "node_modules/@casl/prisma": { diff --git a/examples/bri-3/src/main.ts b/examples/bri-3/src/main.ts index c90edb3c6..4cdb055a1 100644 --- a/examples/bri-3/src/main.ts +++ b/examples/bri-3/src/main.ts @@ -10,7 +10,7 @@ async function bootstrap() { }), ); - //Please refer and document here: https://github.com/eea-oasis/baseline/issues/593 + //Please refer and document here: https://github.com/ethereum-oasis-op/baseline/issues/593 app.enableCors(); await app.listen(3000); } diff --git a/examples/bri-1/base-example/.gitignore b/examples/deprecated/bri-1/base-example/.gitignore similarity index 100% rename from examples/bri-1/base-example/.gitignore rename to examples/deprecated/bri-1/base-example/.gitignore diff --git a/examples/bri-1/base-example/.npmignore b/examples/deprecated/bri-1/base-example/.npmignore similarity index 100% rename from examples/bri-1/base-example/.npmignore rename to examples/deprecated/bri-1/base-example/.npmignore diff --git a/examples/bri-1/base-example/Makefile b/examples/deprecated/bri-1/base-example/Makefile similarity index 100% rename from examples/bri-1/base-example/Makefile rename to examples/deprecated/bri-1/base-example/Makefile diff --git a/examples/bri-1/base-example/README.md b/examples/deprecated/bri-1/base-example/README.md similarity index 100% rename from examples/bri-1/base-example/README.md rename to examples/deprecated/bri-1/base-example/README.md diff --git a/examples/bri-1/base-example/docker-compose.yml b/examples/deprecated/bri-1/base-example/docker-compose.yml similarity index 100% rename from examples/bri-1/base-example/docker-compose.yml rename to examples/deprecated/bri-1/base-example/docker-compose.yml diff --git a/examples/bri-1/base-example/ops/await_tcp.sh b/examples/deprecated/bri-1/base-example/ops/await_tcp.sh old mode 100755 new mode 100644 similarity index 100% rename from examples/bri-1/base-example/ops/await_tcp.sh rename to examples/deprecated/bri-1/base-example/ops/await_tcp.sh diff --git a/examples/bri-1/base-example/ops/splunk/abis/BN256G2.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/BN256G2.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/BN256G2.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/BN256G2.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/Context.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/Context.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/Context.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/Context.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/ERC165.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/ERC165.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/ERC165.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/ERC165.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/ERC165Compatible.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/ERC165Compatible.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/ERC165Compatible.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/ERC165Compatible.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/ERC1820ImplementerInterface.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/ERC1820ImplementerInterface.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/ERC1820ImplementerInterface.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/ERC1820ImplementerInterface.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/ERC1820Registry.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/ERC1820Registry.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/ERC1820Registry.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/ERC1820Registry.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/IERC165.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/IERC165.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/IERC165.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/IERC165.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/IOrgRegistry.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/IOrgRegistry.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/IOrgRegistry.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/IOrgRegistry.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/IShield.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/IShield.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/IShield.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/IShield.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/IVerifier.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/IVerifier.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/IVerifier.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/IVerifier.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/MerkleTree.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/MerkleTree.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/MerkleTree.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/MerkleTree.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/OrgRegistry.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/OrgRegistry.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/OrgRegistry.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/OrgRegistry.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/Ownable.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/Ownable.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/Ownable.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/Ownable.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/Pairing.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/Pairing.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/Pairing.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/Pairing.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/Registrar.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/Registrar.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/Registrar.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/Registrar.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/SampleERC1820Implementer.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/SampleERC1820Implementer.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/SampleERC1820Implementer.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/SampleERC1820Implementer.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/BN256G2.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/BN256G2.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/BN256G2.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/BN256G2.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/ERC165.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/ERC165.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/ERC165.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/ERC165.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/ERC165Compatible.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/ERC165Compatible.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/ERC165Compatible.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/ERC165Compatible.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/ERC1820ImplementerInterface.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/ERC1820ImplementerInterface.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/ERC1820ImplementerInterface.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/ERC1820ImplementerInterface.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/ERC1820Registry.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/ERC1820Registry.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/ERC1820Registry.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/ERC1820Registry.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/ERC20.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/ERC20.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/ERC20.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/ERC20.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/ERC20Interface.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/ERC20Interface.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/ERC20Interface.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/ERC20Interface.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/IERC165.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/IERC165.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/IERC165.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/IERC165.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/IOrgRegistry.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/IOrgRegistry.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/IOrgRegistry.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/IOrgRegistry.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/IShield.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/IShield.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/IShield.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/IShield.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/IVerifier.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/IVerifier.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/IVerifier.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/IVerifier.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/MerkleTree.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/MerkleTree.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/MerkleTree.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/MerkleTree.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/OrgRegistry.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/OrgRegistry.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/OrgRegistry.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/OrgRegistry.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/Ownable.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/Ownable.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/Ownable.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/Ownable.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/Pairing.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/Pairing.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/Pairing.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/Pairing.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/Registrar.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/Registrar.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/Registrar.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/Registrar.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/Roles.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/Roles.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/Roles.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/Roles.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/SafeMath.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/SafeMath.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/SafeMath.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/SafeMath.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/SampleERC1820Implementer.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/SampleERC1820Implementer.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/SampleERC1820Implementer.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/SampleERC1820Implementer.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/Shield.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/Shield.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/Shield.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/Shield.json diff --git a/examples/bri-1/base-example/ops/splunk/abis/baseline/Verifier.json b/examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/Verifier.json similarity index 100% rename from examples/bri-1/base-example/ops/splunk/abis/baseline/Verifier.json rename to examples/deprecated/bri-1/base-example/ops/splunk/abis/baseline/Verifier.json diff --git a/examples/bri-1/base-example/ops/splunk/dashboards/.keep b/examples/deprecated/bri-1/base-example/ops/splunk/dashboards/.keep similarity index 100% rename from examples/bri-1/base-example/ops/splunk/dashboards/.keep rename to examples/deprecated/bri-1/base-example/ops/splunk/dashboards/.keep diff --git a/examples/bri-1/base-example/ops/splunk/docker-compose.yml b/examples/deprecated/bri-1/base-example/ops/splunk/docker-compose.yml similarity index 100% rename from examples/bri-1/base-example/ops/splunk/docker-compose.yml rename to examples/deprecated/bri-1/base-example/ops/splunk/docker-compose.yml diff --git a/examples/bri-1/base-example/ops/splunk/ops/await_tcp.sh b/examples/deprecated/bri-1/base-example/ops/splunk/ops/await_tcp.sh similarity index 100% rename from examples/bri-1/base-example/ops/splunk/ops/await_tcp.sh rename to examples/deprecated/bri-1/base-example/ops/splunk/ops/await_tcp.sh diff --git a/examples/bri-1/base-example/ops/splunk/splunk-config.yml b/examples/deprecated/bri-1/base-example/ops/splunk/splunk-config.yml similarity index 100% rename from examples/bri-1/base-example/ops/splunk/splunk-config.yml rename to examples/deprecated/bri-1/base-example/ops/splunk/splunk-config.yml diff --git a/examples/bri-1/base-example/package-lock.json b/examples/deprecated/bri-1/base-example/package-lock.json similarity index 100% rename from examples/bri-1/base-example/package-lock.json rename to examples/deprecated/bri-1/base-example/package-lock.json diff --git a/examples/bri-1/base-example/package.json b/examples/deprecated/bri-1/base-example/package.json similarity index 100% rename from examples/bri-1/base-example/package.json rename to examples/deprecated/bri-1/base-example/package.json diff --git a/examples/bri-1/base-example/src/index.ts b/examples/deprecated/bri-1/base-example/src/index.ts similarity index 100% rename from examples/bri-1/base-example/src/index.ts rename to examples/deprecated/bri-1/base-example/src/index.ts diff --git a/examples/bri-1/base-example/test/e2e.spec.ts b/examples/deprecated/bri-1/base-example/test/e2e.spec.ts similarity index 100% rename from examples/bri-1/base-example/test/e2e.spec.ts rename to examples/deprecated/bri-1/base-example/test/e2e.spec.ts diff --git a/examples/bri-1/base-example/test/shared.ts b/examples/deprecated/bri-1/base-example/test/shared.ts similarity index 100% rename from examples/bri-1/base-example/test/shared.ts rename to examples/deprecated/bri-1/base-example/test/shared.ts diff --git a/examples/bri-1/base-example/test/utils.ts b/examples/deprecated/bri-1/base-example/test/utils.ts similarity index 100% rename from examples/bri-1/base-example/test/utils.ts rename to examples/deprecated/bri-1/base-example/test/utils.ts diff --git a/examples/bri-1/base-example/tsconfig.cjs.json b/examples/deprecated/bri-1/base-example/tsconfig.cjs.json similarity index 100% rename from examples/bri-1/base-example/tsconfig.cjs.json rename to examples/deprecated/bri-1/base-example/tsconfig.cjs.json diff --git a/examples/bri-1/base-example/tsconfig.json b/examples/deprecated/bri-1/base-example/tsconfig.json similarity index 100% rename from examples/bri-1/base-example/tsconfig.json rename to examples/deprecated/bri-1/base-example/tsconfig.json diff --git a/examples/bri-1/base-example/tslint.json b/examples/deprecated/bri-1/base-example/tslint.json similarity index 100% rename from examples/bri-1/base-example/tslint.json rename to examples/deprecated/bri-1/base-example/tslint.json diff --git a/examples/bri-1/base-example/webpack.config.js b/examples/deprecated/bri-1/base-example/webpack.config.js similarity index 100% rename from examples/bri-1/base-example/webpack.config.js rename to examples/deprecated/bri-1/base-example/webpack.config.js diff --git a/examples/bri-1/lib/erp-connector-proxy/.gitignore b/examples/deprecated/bri-1/lib/erp-connector-proxy/.gitignore similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/.gitignore rename to examples/deprecated/bri-1/lib/erp-connector-proxy/.gitignore diff --git a/examples/bri-1/lib/erp-connector-proxy/Controllers/AuthenticationController.cs b/examples/deprecated/bri-1/lib/erp-connector-proxy/Controllers/AuthenticationController.cs similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/Controllers/AuthenticationController.cs rename to examples/deprecated/bri-1/lib/erp-connector-proxy/Controllers/AuthenticationController.cs diff --git a/examples/bri-1/lib/erp-connector-proxy/Controllers/ClaimRequirementAttribute.cs b/examples/deprecated/bri-1/lib/erp-connector-proxy/Controllers/ClaimRequirementAttribute.cs similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/Controllers/ClaimRequirementAttribute.cs rename to examples/deprecated/bri-1/lib/erp-connector-proxy/Controllers/ClaimRequirementAttribute.cs diff --git a/examples/bri-1/lib/erp-connector-proxy/Controllers/ProposalsController.cs b/examples/deprecated/bri-1/lib/erp-connector-proxy/Controllers/ProposalsController.cs similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/Controllers/ProposalsController.cs rename to examples/deprecated/bri-1/lib/erp-connector-proxy/Controllers/ProposalsController.cs diff --git a/examples/bri-1/lib/erp-connector-proxy/Controllers/PurchaseOrdersController.cs b/examples/deprecated/bri-1/lib/erp-connector-proxy/Controllers/PurchaseOrdersController.cs similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/Controllers/PurchaseOrdersController.cs rename to examples/deprecated/bri-1/lib/erp-connector-proxy/Controllers/PurchaseOrdersController.cs diff --git a/examples/bri-1/lib/erp-connector-proxy/Controllers/RequestForProposalsController.cs b/examples/deprecated/bri-1/lib/erp-connector-proxy/Controllers/RequestForProposalsController.cs similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/Controllers/RequestForProposalsController.cs rename to examples/deprecated/bri-1/lib/erp-connector-proxy/Controllers/RequestForProposalsController.cs diff --git a/examples/bri-1/lib/erp-connector-proxy/Dockerfile b/examples/deprecated/bri-1/lib/erp-connector-proxy/Dockerfile similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/Dockerfile rename to examples/deprecated/bri-1/lib/erp-connector-proxy/Dockerfile diff --git a/examples/bri-1/lib/erp-connector-proxy/Domain/Model/AuthRequest.cs b/examples/deprecated/bri-1/lib/erp-connector-proxy/Domain/Model/AuthRequest.cs similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/Domain/Model/AuthRequest.cs rename to examples/deprecated/bri-1/lib/erp-connector-proxy/Domain/Model/AuthRequest.cs diff --git a/examples/bri-1/lib/erp-connector-proxy/Domain/Model/Participant.cs b/examples/deprecated/bri-1/lib/erp-connector-proxy/Domain/Model/Participant.cs similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/Domain/Model/Participant.cs rename to examples/deprecated/bri-1/lib/erp-connector-proxy/Domain/Model/Participant.cs diff --git a/examples/bri-1/lib/erp-connector-proxy/Domain/Repositories/IRadish34Repository.cs b/examples/deprecated/bri-1/lib/erp-connector-proxy/Domain/Repositories/IRadish34Repository.cs similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/Domain/Repositories/IRadish34Repository.cs rename to examples/deprecated/bri-1/lib/erp-connector-proxy/Domain/Repositories/IRadish34Repository.cs diff --git a/examples/bri-1/lib/erp-connector-proxy/Domain/Services/IRadish34BuyerService.cs b/examples/deprecated/bri-1/lib/erp-connector-proxy/Domain/Services/IRadish34BuyerService.cs similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/Domain/Services/IRadish34BuyerService.cs rename to examples/deprecated/bri-1/lib/erp-connector-proxy/Domain/Services/IRadish34BuyerService.cs diff --git a/examples/bri-1/lib/erp-connector-proxy/Domain/Services/IRadish34Service.cs b/examples/deprecated/bri-1/lib/erp-connector-proxy/Domain/Services/IRadish34Service.cs similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/Domain/Services/IRadish34Service.cs rename to examples/deprecated/bri-1/lib/erp-connector-proxy/Domain/Services/IRadish34Service.cs diff --git a/examples/bri-1/lib/erp-connector-proxy/Domain/Services/IRadish34SupplierService.cs b/examples/deprecated/bri-1/lib/erp-connector-proxy/Domain/Services/IRadish34SupplierService.cs similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/Domain/Services/IRadish34SupplierService.cs rename to examples/deprecated/bri-1/lib/erp-connector-proxy/Domain/Services/IRadish34SupplierService.cs diff --git a/examples/bri-1/lib/erp-connector-proxy/Program.cs b/examples/deprecated/bri-1/lib/erp-connector-proxy/Program.cs similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/Program.cs rename to examples/deprecated/bri-1/lib/erp-connector-proxy/Program.cs diff --git a/examples/bri-1/lib/erp-connector-proxy/Properties/launchSettings.json b/examples/deprecated/bri-1/lib/erp-connector-proxy/Properties/launchSettings.json similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/Properties/launchSettings.json rename to examples/deprecated/bri-1/lib/erp-connector-proxy/Properties/launchSettings.json diff --git a/examples/bri-1/lib/erp-connector-proxy/README.md b/examples/deprecated/bri-1/lib/erp-connector-proxy/README.md similarity index 94% rename from examples/bri-1/lib/erp-connector-proxy/README.md rename to examples/deprecated/bri-1/lib/erp-connector-proxy/README.md index 6ebdeee63..e23927ec2 100644 --- a/examples/bri-1/lib/erp-connector-proxy/README.md +++ b/examples/deprecated/bri-1/lib/erp-connector-proxy/README.md @@ -1,4 +1,4 @@ -**⚠️ The "Baseline-SAP-Dynamics" demo is being integrated with [this new reference implementation](https://github.com/ethereum-oasis/baseline/tree/master/examples/shuttle-app) as a result of the `v0.1` release.** +**⚠️ The "Baseline-SAP-Dynamics" demo is being integrated with [this new reference implementation](https://github.com/ethereum-oasis-op/baseline/tree/main/examples/shuttle-app) as a result of the `v0.1` release.** # Baselining Business Process Automation across SAP and Microsoft Dynamics @@ -22,7 +22,7 @@ You can find all the details on the Baseline Protocol [here](https://www.baselin # Challenges and Scope of Work -The setting of tasks in the Community Bootstrapping Phase of Baseline [roadmap](https://github.com/ethereum-oasis/baseline-roadmap) include extraction of concepts out of the Radish34 demo case into the protocol level. This demo therefore wants to extend the Radish34 case by integrating off-chain systems of record, to work out major challenges and provide solutions to them. The learnings should be manifested in a reference implementation that can support standards on the protocol itself. +The setting of tasks in the Community Bootstrapping Phase of Baseline [roadmap](https://github.com/ethereum-oasis-op/baseline-roadmap) include extraction of concepts out of the Radish34 demo case into the protocol level. This demo therefore wants to extend the Radish34 case by integrating off-chain systems of record, to work out major challenges and provide solutions to them. The learnings should be manifested in a reference implementation that can support standards on the protocol itself. The Use-case shown in the demo follows this path: @@ -56,7 +56,7 @@ The architecture proposal of this demo builds upon the existing microservices, a ![Shuttle Microservice Containers](docs/images/image5.png)
**Microservice container environment for a participant in a baselined business process.** -**Baseline Containers**: The microservices providing the Baseline Protocol and Radish34 use-case, based on this [branch](https://github.com/ethereum-oasis/baseline/tree/init-core) in GitHub, including several key fixes (i.e., unwiring cyclic dependencies within the existing Radish34 environment) and enhancements (i.e., point-to-point messaging between parties, use of a generalized circuit for baselining agreements). +**Baseline Containers**: The microservices providing the Baseline Protocol and Radish34 use-case, based on this [branch](https://github.com/ethereum-oasis-op/baseline/tree/init-core) in GitHub, including several key fixes (i.e., unwiring cyclic dependencies within the existing Radish34 environment) and enhancements (i.e., point-to-point messaging between parties, use of a generalized circuit for baselining agreements). **Provide Containers**: Provide's identity, key management, blockchain and messaging microservice API containers representing the technical entry point and translation layer for data and baseline protocol messages, and the provider of messaging infrastructure leveraged by the Baseline stack for secure point-to-point messaging. diff --git a/examples/bri-1/lib/erp-connector-proxy/Repositories/Radish34Repository.cs b/examples/deprecated/bri-1/lib/erp-connector-proxy/Repositories/Radish34Repository.cs similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/Repositories/Radish34Repository.cs rename to examples/deprecated/bri-1/lib/erp-connector-proxy/Repositories/Radish34Repository.cs diff --git a/examples/bri-1/lib/erp-connector-proxy/Services/Radish34BuyerService.cs b/examples/deprecated/bri-1/lib/erp-connector-proxy/Services/Radish34BuyerService.cs similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/Services/Radish34BuyerService.cs rename to examples/deprecated/bri-1/lib/erp-connector-proxy/Services/Radish34BuyerService.cs diff --git a/examples/bri-1/lib/erp-connector-proxy/Services/Radish34Service.cs b/examples/deprecated/bri-1/lib/erp-connector-proxy/Services/Radish34Service.cs similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/Services/Radish34Service.cs rename to examples/deprecated/bri-1/lib/erp-connector-proxy/Services/Radish34Service.cs diff --git a/examples/bri-1/lib/erp-connector-proxy/Services/Radish34SupplierService.cs b/examples/deprecated/bri-1/lib/erp-connector-proxy/Services/Radish34SupplierService.cs similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/Services/Radish34SupplierService.cs rename to examples/deprecated/bri-1/lib/erp-connector-proxy/Services/Radish34SupplierService.cs diff --git a/examples/bri-1/lib/erp-connector-proxy/Startup.cs b/examples/deprecated/bri-1/lib/erp-connector-proxy/Startup.cs similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/Startup.cs rename to examples/deprecated/bri-1/lib/erp-connector-proxy/Startup.cs diff --git a/examples/bri-1/lib/erp-connector-proxy/appsettings.Development.json b/examples/deprecated/bri-1/lib/erp-connector-proxy/appsettings.Development.json similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/appsettings.Development.json rename to examples/deprecated/bri-1/lib/erp-connector-proxy/appsettings.Development.json diff --git a/examples/bri-1/lib/erp-connector-proxy/appsettings.json b/examples/deprecated/bri-1/lib/erp-connector-proxy/appsettings.json similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/appsettings.json rename to examples/deprecated/bri-1/lib/erp-connector-proxy/appsettings.json diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image1.png b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image1.png similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image1.png rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image1.png diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image10.png b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image10.png similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image10.png rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image10.png diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image11.gif b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image11.gif similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image11.gif rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image11.gif diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image12.jpg b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image12.jpg similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image12.jpg rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image12.jpg diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image13.png b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image13.png similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image13.png rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image13.png diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image14.png b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image14.png similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image14.png rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image14.png diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image15.png b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image15.png similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image15.png rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image15.png diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image16.png b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image16.png similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image16.png rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image16.png diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image17.png b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image17.png similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image17.png rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image17.png diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image18.png b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image18.png similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image18.png rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image18.png diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image19.jpg b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image19.jpg similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image19.jpg rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image19.jpg diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image2.png b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image2.png similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image2.png rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image2.png diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image20.jpg b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image20.jpg similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image20.jpg rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image20.jpg diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image3.png b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image3.png similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image3.png rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image3.png diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image4.png b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image4.png similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image4.png rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image4.png diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image5.png b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image5.png similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image5.png rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image5.png diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image6.png b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image6.png similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image6.png rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image6.png diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image7.png b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image7.png similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image7.png rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image7.png diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image8.jpg b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image8.jpg similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image8.jpg rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image8.jpg diff --git a/examples/bri-1/lib/erp-connector-proxy/docs/images/image9.png b/examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image9.png similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/docs/images/image9.png rename to examples/deprecated/bri-1/lib/erp-connector-proxy/docs/images/image9.png diff --git a/examples/bri-1/lib/erp-connector-proxy/radishproxy.API.csproj b/examples/deprecated/bri-1/lib/erp-connector-proxy/radishproxy.API.csproj similarity index 100% rename from examples/bri-1/lib/erp-connector-proxy/radishproxy.API.csproj rename to examples/deprecated/bri-1/lib/erp-connector-proxy/radishproxy.API.csproj diff --git a/examples/bri-1/lib/excel-connector/.eslintrc.json b/examples/deprecated/bri-1/lib/excel-connector/.eslintrc.json similarity index 100% rename from examples/bri-1/lib/excel-connector/.eslintrc.json rename to examples/deprecated/bri-1/lib/excel-connector/.eslintrc.json diff --git a/examples/bri-1/lib/excel-connector/.gitignore b/examples/deprecated/bri-1/lib/excel-connector/.gitignore similarity index 100% rename from examples/bri-1/lib/excel-connector/.gitignore rename to examples/deprecated/bri-1/lib/excel-connector/.gitignore diff --git a/examples/bri-1/lib/excel-connector/.vscode/extensions.json b/examples/deprecated/bri-1/lib/excel-connector/.vscode/extensions.json similarity index 100% rename from examples/bri-1/lib/excel-connector/.vscode/extensions.json rename to examples/deprecated/bri-1/lib/excel-connector/.vscode/extensions.json diff --git a/examples/bri-1/lib/excel-connector/.vscode/launch.json b/examples/deprecated/bri-1/lib/excel-connector/.vscode/launch.json similarity index 100% rename from examples/bri-1/lib/excel-connector/.vscode/launch.json rename to examples/deprecated/bri-1/lib/excel-connector/.vscode/launch.json diff --git a/examples/bri-1/lib/excel-connector/.vscode/settings.json b/examples/deprecated/bri-1/lib/excel-connector/.vscode/settings.json similarity index 100% rename from examples/bri-1/lib/excel-connector/.vscode/settings.json rename to examples/deprecated/bri-1/lib/excel-connector/.vscode/settings.json diff --git a/examples/bri-1/lib/excel-connector/.vscode/tasks.json b/examples/deprecated/bri-1/lib/excel-connector/.vscode/tasks.json similarity index 100% rename from examples/bri-1/lib/excel-connector/.vscode/tasks.json rename to examples/deprecated/bri-1/lib/excel-connector/.vscode/tasks.json diff --git a/examples/bri-1/lib/excel-connector/README.md b/examples/deprecated/bri-1/lib/excel-connector/README.md similarity index 85% rename from examples/bri-1/lib/excel-connector/README.md rename to examples/deprecated/bri-1/lib/excel-connector/README.md index 08eada4b6..69937b2aa 100644 --- a/examples/bri-1/lib/excel-connector/README.md +++ b/examples/deprecated/bri-1/lib/excel-connector/README.md @@ -9,7 +9,7 @@ Shuttle-Excel is a connector for Microsoft Excel that allows Excel sheets to con ## Installation -Clone the Baseline Protocol [repo](https://github.com/eea-oasis/baseline). The Excel-Addin is located in the baseline/examples/bri-1/lib/excel-connector. Go to the folder and run the following command to install all the node modules. +Clone the Baseline Protocol [repo](https://github.com/ethereum-oasis-op/baseline). The Excel-Addin is located in the baseline/examples/bri-1/lib/excel-connector. Go to the folder and run the following command to install all the node modules. ```bash npm i diff --git a/examples/bri-1/lib/excel-connector/antigen.zsh b/examples/deprecated/bri-1/lib/excel-connector/antigen.zsh similarity index 100% rename from examples/bri-1/lib/excel-connector/antigen.zsh rename to examples/deprecated/bri-1/lib/excel-connector/antigen.zsh diff --git a/examples/bri-1/lib/excel-connector/assets/icon-128.png b/examples/deprecated/bri-1/lib/excel-connector/assets/icon-128.png similarity index 100% rename from examples/bri-1/lib/excel-connector/assets/icon-128.png rename to examples/deprecated/bri-1/lib/excel-connector/assets/icon-128.png diff --git a/examples/bri-1/lib/excel-connector/assets/icon-16.png b/examples/deprecated/bri-1/lib/excel-connector/assets/icon-16.png similarity index 100% rename from examples/bri-1/lib/excel-connector/assets/icon-16.png rename to examples/deprecated/bri-1/lib/excel-connector/assets/icon-16.png diff --git a/examples/bri-1/lib/excel-connector/assets/icon-32.png b/examples/deprecated/bri-1/lib/excel-connector/assets/icon-32.png similarity index 100% rename from examples/bri-1/lib/excel-connector/assets/icon-32.png rename to examples/deprecated/bri-1/lib/excel-connector/assets/icon-32.png diff --git a/examples/bri-1/lib/excel-connector/assets/icon-64.png b/examples/deprecated/bri-1/lib/excel-connector/assets/icon-64.png similarity index 100% rename from examples/bri-1/lib/excel-connector/assets/icon-64.png rename to examples/deprecated/bri-1/lib/excel-connector/assets/icon-64.png diff --git a/examples/bri-1/lib/excel-connector/assets/icon-80.png b/examples/deprecated/bri-1/lib/excel-connector/assets/icon-80.png similarity index 100% rename from examples/bri-1/lib/excel-connector/assets/icon-80.png rename to examples/deprecated/bri-1/lib/excel-connector/assets/icon-80.png diff --git a/examples/bri-1/lib/excel-connector/assets/image.png b/examples/deprecated/bri-1/lib/excel-connector/assets/image.png similarity index 100% rename from examples/bri-1/lib/excel-connector/assets/image.png rename to examples/deprecated/bri-1/lib/excel-connector/assets/image.png diff --git a/examples/bri-1/lib/excel-connector/assets/logo-filled.png b/examples/deprecated/bri-1/lib/excel-connector/assets/logo-filled.png similarity index 100% rename from examples/bri-1/lib/excel-connector/assets/logo-filled.png rename to examples/deprecated/bri-1/lib/excel-connector/assets/logo-filled.png diff --git a/examples/bri-1/lib/excel-connector/assets/shuttle-bg.svg b/examples/deprecated/bri-1/lib/excel-connector/assets/shuttle-bg.svg similarity index 100% rename from examples/bri-1/lib/excel-connector/assets/shuttle-bg.svg rename to examples/deprecated/bri-1/lib/excel-connector/assets/shuttle-bg.svg diff --git a/examples/bri-1/lib/excel-connector/assets/shuttle-tmpicon.png b/examples/deprecated/bri-1/lib/excel-connector/assets/shuttle-tmpicon.png similarity index 100% rename from examples/bri-1/lib/excel-connector/assets/shuttle-tmpicon.png rename to examples/deprecated/bri-1/lib/excel-connector/assets/shuttle-tmpicon.png diff --git a/examples/bri-1/lib/excel-connector/babel.config.json b/examples/deprecated/bri-1/lib/excel-connector/babel.config.json similarity index 100% rename from examples/bri-1/lib/excel-connector/babel.config.json rename to examples/deprecated/bri-1/lib/excel-connector/babel.config.json diff --git a/examples/bri-1/lib/excel-connector/manifest.xml b/examples/deprecated/bri-1/lib/excel-connector/manifest.xml similarity index 100% rename from examples/bri-1/lib/excel-connector/manifest.xml rename to examples/deprecated/bri-1/lib/excel-connector/manifest.xml diff --git a/examples/bri-1/lib/excel-connector/package-lock.json b/examples/deprecated/bri-1/lib/excel-connector/package-lock.json similarity index 100% rename from examples/bri-1/lib/excel-connector/package-lock.json rename to examples/deprecated/bri-1/lib/excel-connector/package-lock.json diff --git a/examples/bri-1/lib/excel-connector/package.json b/examples/deprecated/bri-1/lib/excel-connector/package.json similarity index 100% rename from examples/bri-1/lib/excel-connector/package.json rename to examples/deprecated/bri-1/lib/excel-connector/package.json diff --git a/examples/bri-1/lib/excel-connector/src/baseline/api.ts b/examples/deprecated/bri-1/lib/excel-connector/src/baseline/api.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/baseline/api.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/baseline/api.ts diff --git a/examples/bri-1/lib/excel-connector/src/baseline/excel-handler.ts b/examples/deprecated/bri-1/lib/excel-connector/src/baseline/excel-handler.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/baseline/excel-handler.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/baseline/excel-handler.ts diff --git a/examples/bri-1/lib/excel-connector/src/baseline/inbound.ts b/examples/deprecated/bri-1/lib/excel-connector/src/baseline/inbound.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/baseline/inbound.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/baseline/inbound.ts diff --git a/examples/bri-1/lib/excel-connector/src/baseline/index.ts b/examples/deprecated/bri-1/lib/excel-connector/src/baseline/index.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/baseline/index.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/baseline/index.ts diff --git a/examples/bri-1/lib/excel-connector/src/baseline/outbound.ts b/examples/deprecated/bri-1/lib/excel-connector/src/baseline/outbound.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/baseline/outbound.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/baseline/outbound.ts diff --git a/examples/bri-1/lib/excel-connector/src/client/access-token.ts b/examples/deprecated/bri-1/lib/excel-connector/src/client/access-token.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/client/access-token.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/client/access-token.ts diff --git a/examples/bri-1/lib/excel-connector/src/client/auth-context.ts b/examples/deprecated/bri-1/lib/excel-connector/src/client/auth-context.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/client/auth-context.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/client/auth-context.ts diff --git a/examples/bri-1/lib/excel-connector/src/client/nats-listener.ts b/examples/deprecated/bri-1/lib/excel-connector/src/client/nats-listener.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/client/nats-listener.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/client/nats-listener.ts diff --git a/examples/bri-1/lib/excel-connector/src/client/provide-client.ts b/examples/deprecated/bri-1/lib/excel-connector/src/client/provide-client.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/client/provide-client.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/client/provide-client.ts diff --git a/examples/bri-1/lib/excel-connector/src/commands/commands.html b/examples/deprecated/bri-1/lib/excel-connector/src/commands/commands.html similarity index 100% rename from examples/bri-1/lib/excel-connector/src/commands/commands.html rename to examples/deprecated/bri-1/lib/excel-connector/src/commands/commands.html diff --git a/examples/bri-1/lib/excel-connector/src/commands/commands.ts b/examples/deprecated/bri-1/lib/excel-connector/src/commands/commands.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/commands/commands.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/commands/commands.ts diff --git a/examples/bri-1/lib/excel-connector/src/commands/readme.txt b/examples/deprecated/bri-1/lib/excel-connector/src/commands/readme.txt similarity index 100% rename from examples/bri-1/lib/excel-connector/src/commands/readme.txt rename to examples/deprecated/bri-1/lib/excel-connector/src/commands/readme.txt diff --git a/examples/bri-1/lib/excel-connector/src/common/alerts.ts b/examples/deprecated/bri-1/lib/excel-connector/src/common/alerts.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/common/alerts.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/common/alerts.ts diff --git a/examples/bri-1/lib/excel-connector/src/common/common.ts b/examples/deprecated/bri-1/lib/excel-connector/src/common/common.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/common/common.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/common/common.ts diff --git a/examples/bri-1/lib/excel-connector/src/common/validate.ts b/examples/deprecated/bri-1/lib/excel-connector/src/common/validate.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/common/validate.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/common/validate.ts diff --git a/examples/bri-1/lib/excel-connector/src/dialogs/dialogs-helpers.ts b/examples/deprecated/bri-1/lib/excel-connector/src/dialogs/dialogs-helpers.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/dialogs/dialogs-helpers.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/dialogs/dialogs-helpers.ts diff --git a/examples/bri-1/lib/excel-connector/src/dialogs/dialogs.ts b/examples/deprecated/bri-1/lib/excel-connector/src/dialogs/dialogs.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/dialogs/dialogs.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/dialogs/dialogs.ts diff --git a/examples/bri-1/lib/excel-connector/src/dialogs/jwtInputDialog.html b/examples/deprecated/bri-1/lib/excel-connector/src/dialogs/jwtInputDialog.html similarity index 100% rename from examples/bri-1/lib/excel-connector/src/dialogs/jwtInputDialog.html rename to examples/deprecated/bri-1/lib/excel-connector/src/dialogs/jwtInputDialog.html diff --git a/examples/bri-1/lib/excel-connector/src/dialogs/jwtInputDialog.ts b/examples/deprecated/bri-1/lib/excel-connector/src/dialogs/jwtInputDialog.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/dialogs/jwtInputDialog.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/dialogs/jwtInputDialog.ts diff --git a/examples/bri-1/lib/excel-connector/src/dialogs/models/jwt-input-data.ts b/examples/deprecated/bri-1/lib/excel-connector/src/dialogs/models/jwt-input-data.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/dialogs/models/jwt-input-data.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/dialogs/models/jwt-input-data.ts diff --git a/examples/bri-1/lib/excel-connector/src/dialogs/models/primary-key-input-data.ts b/examples/deprecated/bri-1/lib/excel-connector/src/dialogs/models/primary-key-input-data.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/dialogs/models/primary-key-input-data.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/dialogs/models/primary-key-input-data.ts diff --git a/examples/bri-1/lib/excel-connector/src/dialogs/primaryKeyDialog.html b/examples/deprecated/bri-1/lib/excel-connector/src/dialogs/primaryKeyDialog.html similarity index 100% rename from examples/bri-1/lib/excel-connector/src/dialogs/primaryKeyDialog.html rename to examples/deprecated/bri-1/lib/excel-connector/src/dialogs/primaryKeyDialog.html diff --git a/examples/bri-1/lib/excel-connector/src/dialogs/primaryKeyDialog.ts b/examples/deprecated/bri-1/lib/excel-connector/src/dialogs/primaryKeyDialog.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/dialogs/primaryKeyDialog.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/dialogs/primaryKeyDialog.ts diff --git a/examples/bri-1/lib/excel-connector/src/models/auth-params.ts b/examples/deprecated/bri-1/lib/excel-connector/src/models/auth-params.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/models/auth-params.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/models/auth-params.ts diff --git a/examples/bri-1/lib/excel-connector/src/models/common.ts b/examples/deprecated/bri-1/lib/excel-connector/src/models/common.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/models/common.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/models/common.ts diff --git a/examples/bri-1/lib/excel-connector/src/models/login-form-data.ts b/examples/deprecated/bri-1/lib/excel-connector/src/models/login-form-data.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/models/login-form-data.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/models/login-form-data.ts diff --git a/examples/bri-1/lib/excel-connector/src/models/protocolMessage.ts b/examples/deprecated/bri-1/lib/excel-connector/src/models/protocolMessage.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/models/protocolMessage.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/models/protocolMessage.ts diff --git a/examples/bri-1/lib/excel-connector/src/models/record.ts b/examples/deprecated/bri-1/lib/excel-connector/src/models/record.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/models/record.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/models/record.ts diff --git a/examples/bri-1/lib/excel-connector/src/models/token.ts b/examples/deprecated/bri-1/lib/excel-connector/src/models/token.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/models/token.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/models/token.ts diff --git a/examples/bri-1/lib/excel-connector/src/models/user.ts b/examples/deprecated/bri-1/lib/excel-connector/src/models/user.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/models/user.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/models/user.ts diff --git a/examples/bri-1/lib/excel-connector/src/settings/crypto.ts b/examples/deprecated/bri-1/lib/excel-connector/src/settings/crypto.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/settings/crypto.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/settings/crypto.ts diff --git a/examples/bri-1/lib/excel-connector/src/settings/settings.ts b/examples/deprecated/bri-1/lib/excel-connector/src/settings/settings.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/settings/settings.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/settings/settings.ts diff --git a/examples/bri-1/lib/excel-connector/src/settings/store.ts b/examples/deprecated/bri-1/lib/excel-connector/src/settings/store.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/settings/store.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/settings/store.ts diff --git a/examples/bri-1/lib/excel-connector/src/taskpane/excel-worker.ts b/examples/deprecated/bri-1/lib/excel-connector/src/taskpane/excel-worker.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/taskpane/excel-worker.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/taskpane/excel-worker.ts diff --git a/examples/bri-1/lib/excel-connector/src/taskpane/mappingForm.ts b/examples/deprecated/bri-1/lib/excel-connector/src/taskpane/mappingForm.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/taskpane/mappingForm.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/taskpane/mappingForm.ts diff --git a/examples/bri-1/lib/excel-connector/src/taskpane/taskpane.css b/examples/deprecated/bri-1/lib/excel-connector/src/taskpane/taskpane.css similarity index 100% rename from examples/bri-1/lib/excel-connector/src/taskpane/taskpane.css rename to examples/deprecated/bri-1/lib/excel-connector/src/taskpane/taskpane.css diff --git a/examples/bri-1/lib/excel-connector/src/taskpane/taskpane.html b/examples/deprecated/bri-1/lib/excel-connector/src/taskpane/taskpane.html similarity index 100% rename from examples/bri-1/lib/excel-connector/src/taskpane/taskpane.html rename to examples/deprecated/bri-1/lib/excel-connector/src/taskpane/taskpane.html diff --git a/examples/bri-1/lib/excel-connector/src/taskpane/taskpane.ts b/examples/deprecated/bri-1/lib/excel-connector/src/taskpane/taskpane.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/taskpane/taskpane.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/taskpane/taskpane.ts diff --git a/examples/bri-1/lib/excel-connector/src/taskpane/workflow.ts b/examples/deprecated/bri-1/lib/excel-connector/src/taskpane/workflow.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/taskpane/workflow.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/taskpane/workflow.ts diff --git a/examples/bri-1/lib/excel-connector/src/taskpane/workstep.ts b/examples/deprecated/bri-1/lib/excel-connector/src/taskpane/workstep.ts similarity index 100% rename from examples/bri-1/lib/excel-connector/src/taskpane/workstep.ts rename to examples/deprecated/bri-1/lib/excel-connector/src/taskpane/workstep.ts diff --git a/examples/bri-1/lib/excel-connector/tsconfig.json b/examples/deprecated/bri-1/lib/excel-connector/tsconfig.json similarity index 100% rename from examples/bri-1/lib/excel-connector/tsconfig.json rename to examples/deprecated/bri-1/lib/excel-connector/tsconfig.json diff --git a/examples/bri-1/lib/excel-connector/webpack.config.js b/examples/deprecated/bri-1/lib/excel-connector/webpack.config.js similarity index 100% rename from examples/bri-1/lib/excel-connector/webpack.config.js rename to examples/deprecated/bri-1/lib/excel-connector/webpack.config.js diff --git a/examples/bri-1/lib/excel-connector/zshrc b/examples/deprecated/bri-1/lib/excel-connector/zshrc similarity index 100% rename from examples/bri-1/lib/excel-connector/zshrc rename to examples/deprecated/bri-1/lib/excel-connector/zshrc diff --git a/examples/bri-1/lib/google-sheets-connector/README.md b/examples/deprecated/bri-1/lib/google-sheets-connector/README.md similarity index 94% rename from examples/bri-1/lib/google-sheets-connector/README.md rename to examples/deprecated/bri-1/lib/google-sheets-connector/README.md index 5db0aad59..7ea31f8fd 100644 --- a/examples/bri-1/lib/google-sheets-connector/README.md +++ b/examples/deprecated/bri-1/lib/google-sheets-connector/README.md @@ -1,6 +1,6 @@ -**⚠️ The "Baseline Mycrosoft Dynamics and Google Sheets" initiative is being integrated with [this new reference implementation](https://github.com/ethereum-oasis/baseline/tree/master/examples/shuttle-app) as a result of the `v0.1` release.** +**⚠️ The "Baseline Mycrosoft Dynamics and Google Sheets" initiative is being integrated with [this new reference implementation](https://github.com/ethereum-oasis-op/baseline/tree/main/examples/shuttle-app) as a result of the `v0.1` release.** -**🚀 The "Baseline Mycrosoft Dynamics and Google Sheets" source code can be found [here](https://github.com/ethereum-oasis/baseline/tree/init-core/examples/google-sheets-connector) on the `init-core` branch, as discussed above.** +**🚀 The "Baseline Mycrosoft Dynamics and Google Sheets" source code can be found [here](https://github.com/ethereum-oasis-op/baseline/tree/init-core/examples/google-sheets-connector) on the `init-core` branch, as discussed above.** # Baselining Business Process Automation across SAP and Microsoft Dynamics diff --git a/examples/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Controllers/Proposal/ProposalController.cs b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Controllers/Proposal/ProposalController.cs similarity index 97% rename from examples/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Controllers/Proposal/ProposalController.cs rename to examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Controllers/Proposal/ProposalController.cs index 5d3302cc7..36b2559cf 100644 --- a/examples/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Controllers/Proposal/ProposalController.cs +++ b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Controllers/Proposal/ProposalController.cs @@ -1,93 +1,93 @@ -using System.Collections.Generic; -using System.Net.Http; -using System.Web.Http; -using AuthenticationUtility; -using System.Net.Http.Headers; -using System.Threading.Tasks; -using Newtonsoft.Json; -using System.Text; -using System.Reflection; -using Newtonsoft.Json.Linq; - -namespace BaselineApi.Controllers.Proposal -{ - public class Proposal - { - public string rfqCaseId { get; set; } - public string purchQty { get; set; } - public string purchUnit { get; set; } - public string purchPrice { get; set; } - public string lineNum { get; set; } - - } - - public class ProposalController : ApiController - { - public static string RFQStatusCheck = ClientConfiguration.Default.UriString + "data" + "/RequestForQuotationReplyHeaders?$select=RFQCaseNumber,HighestRFQStatus&$filter=RFQCaseNumber%20eq%20"; - public static string ODataEntityPath = ClientConfiguration.Default.UriString + "data"; - public static string ManageProposalActionPath = "/HandleRFQReplies/Microsoft.Dynamics.DataEntities.manageProposal"; - public static string MediaType = "application/json"; - - // GET: api/Proposal/000385 - public async Task Get(int id) - { - HttpClient client = new HttpClient(); - - client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(MediaType)); - - var authenticationHeader = OAuthHelper.GetAuthenticationHeader(useWebAppAuthentication: true); - string[] splittedToken = authenticationHeader.Split(' '); - - client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", splittedToken[1]); - - string rfqUrl = RFQStatusCheck + "%27" + id.ToString("D6") + "%27"; - var response = await client.GetAsync(rfqUrl); - var contents = await response.Content.ReadAsStringAsync(); - - dynamic json = JsonConvert.DeserializeObject(contents); - dynamic rfqValue = json["value"]; - - if (rfqValue.Count > 0) - { - string status = rfqValue[0]["HighestRFQStatus"]; - - if (status == "Sent") - { - return true; - } - } - - return false; - } - - // POST: api/Proposal - public async Task Post(Proposal value) - { - HttpClient client = new HttpClient(); - - client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(MediaType)); - - var authenticationHeader = OAuthHelper.GetAuthenticationHeader(useWebAppAuthentication: true); - string[] splittedToken = authenticationHeader.Split(' '); - - client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", splittedToken[1]); - - PropertyInfo[] proposalInfos = value.GetType().GetProperties(); - Dictionary proposalDictionary = new Dictionary(); - - foreach (PropertyInfo info in proposalInfos) - { - proposalDictionary.Add(info.Name, info.GetValue(value, null).ToString()); - } - - var json = JsonConvert.SerializeObject(proposalDictionary, Formatting.Indented); - - var stringContent = new StringContent(json, Encoding.UTF8, MediaType); - - var response = await client.PostAsync(ODataEntityPath + ManageProposalActionPath, stringContent); - var contents = await response.Content.ReadAsStringAsync(); - - return contents; - } - } -} +using System.Collections.Generic; +using System.Net.Http; +using System.Web.Http; +using AuthenticationUtility; +using System.Net.Http.Headers; +using System.Threading.Tasks; +using Newtonsoft.Json; +using System.Text; +using System.Reflection; +using Newtonsoft.Json.Linq; + +namespace BaselineApi.Controllers.Proposal +{ + public class Proposal + { + public string rfqCaseId { get; set; } + public string purchQty { get; set; } + public string purchUnit { get; set; } + public string purchPrice { get; set; } + public string lineNum { get; set; } + + } + + public class ProposalController : ApiController + { + public static string RFQStatusCheck = ClientConfiguration.Default.UriString + "data" + "/RequestForQuotationReplyHeaders?$select=RFQCaseNumber,HighestRFQStatus&$filter=RFQCaseNumber%20eq%20"; + public static string ODataEntityPath = ClientConfiguration.Default.UriString + "data"; + public static string ManageProposalActionPath = "/HandleRFQReplies/Microsoft.Dynamics.DataEntities.manageProposal"; + public static string MediaType = "application/json"; + + // GET: api/Proposal/000385 + public async Task Get(int id) + { + HttpClient client = new HttpClient(); + + client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(MediaType)); + + var authenticationHeader = OAuthHelper.GetAuthenticationHeader(useWebAppAuthentication: true); + string[] splittedToken = authenticationHeader.Split(' '); + + client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", splittedToken[1]); + + string rfqUrl = RFQStatusCheck + "%27" + id.ToString("D6") + "%27"; + var response = await client.GetAsync(rfqUrl); + var contents = await response.Content.ReadAsStringAsync(); + + dynamic json = JsonConvert.DeserializeObject(contents); + dynamic rfqValue = json["value"]; + + if (rfqValue.Count > 0) + { + string status = rfqValue[0]["HighestRFQStatus"]; + + if (status == "Sent") + { + return true; + } + } + + return false; + } + + // POST: api/Proposal + public async Task Post(Proposal value) + { + HttpClient client = new HttpClient(); + + client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue(MediaType)); + + var authenticationHeader = OAuthHelper.GetAuthenticationHeader(useWebAppAuthentication: true); + string[] splittedToken = authenticationHeader.Split(' '); + + client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", splittedToken[1]); + + PropertyInfo[] proposalInfos = value.GetType().GetProperties(); + Dictionary proposalDictionary = new Dictionary(); + + foreach (PropertyInfo info in proposalInfos) + { + proposalDictionary.Add(info.Name, info.GetValue(value, null).ToString()); + } + + var json = JsonConvert.SerializeObject(proposalDictionary, Formatting.Indented); + + var stringContent = new StringContent(json, Encoding.UTF8, MediaType); + + var response = await client.PostAsync(ODataEntityPath + ManageProposalActionPath, stringContent); + var contents = await response.Content.ReadAsStringAsync(); + + return contents; + } + } +} diff --git a/examples/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/AuthenticationUtility.csproj b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/AuthenticationUtility.csproj similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/AuthenticationUtility.csproj rename to examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/AuthenticationUtility.csproj diff --git a/examples/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/ClientConfiguration.cs b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/ClientConfiguration.cs similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/ClientConfiguration.cs rename to examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/ClientConfiguration.cs diff --git a/examples/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/OAuthHelper.cs b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/OAuthHelper.cs similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/OAuthHelper.cs rename to examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/OAuthHelper.cs diff --git a/examples/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/Properties/AssemblyInfo.cs b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/Properties/AssemblyInfo.cs similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/Properties/AssemblyInfo.cs rename to examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/Properties/AssemblyInfo.cs diff --git a/examples/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/packages.config b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/packages.config similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/packages.config rename to examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineAPI/Utilities/AuthenticationUtility/packages.config diff --git a/examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/BaselineDll.csproj b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/BaselineDll.csproj similarity index 97% rename from examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/BaselineDll.csproj rename to examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/BaselineDll.csproj index f414485eb..ea907a01c 100644 --- a/examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/BaselineDll.csproj +++ b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/BaselineDll.csproj @@ -1,54 +1,54 @@ - - - - - Debug - AnyCPU - {45DFB5FD-BC18-4C7D-BA97-0F5FE94BC88A} - Library - Properties - BaselineDll - BaselineDll - v4.5.2 - 512 - - - true - full - false - bin\Debug\ - DEBUG;TRACE - prompt - 4 - - - pdbonly - true - bin\Release\ - TRACE - prompt - 4 - - - - - - - - - - - - - - - - - + + + + + Debug + AnyCPU + {45DFB5FD-BC18-4C7D-BA97-0F5FE94BC88A} + Library + Properties + BaselineDll + BaselineDll + v4.5.2 + 512 + + + true + full + false + bin\Debug\ + DEBUG;TRACE + prompt + 4 + + + pdbonly + true + bin\Release\ + TRACE + prompt + 4 + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/Integration.cs b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/Integration.cs similarity index 96% rename from examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/Integration.cs rename to examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/Integration.cs index a3bf7dbbc..5a12181ad 100644 --- a/examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/Integration.cs +++ b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/Integration.cs @@ -1,36 +1,36 @@ -using System; -using System.Net.Http; -using System.Net.Http.Headers; -using System.Threading.Tasks; - -namespace BaselineDll -{ - public class Integration - { - static public async Task PostDocument(string record, string documentType) - { - // Call asynchronous network methods in a try/catch block to handle exceptions. - try - { - string baselineProxyUri = ""; - - HttpClient client = new HttpClient(); - - var stringContent = new StringContent(record); - - client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json")); - - var response = await client.PostAsync(baselineProxyUri + documentType, stringContent); - - return response.ToString(); - } - catch (HttpRequestException e) - { - Console.WriteLine("\nException Caught!"); - Console.WriteLine("Message :{0} ", e.Message); - return null; - } - } - - } -} +using System; +using System.Net.Http; +using System.Net.Http.Headers; +using System.Threading.Tasks; + +namespace BaselineDll +{ + public class Integration + { + static public async Task PostDocument(string record, string documentType) + { + // Call asynchronous network methods in a try/catch block to handle exceptions. + try + { + string baselineProxyUri = ""; + + HttpClient client = new HttpClient(); + + var stringContent = new StringContent(record); + + client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json")); + + var response = await client.PostAsync(baselineProxyUri + documentType, stringContent); + + return response.ToString(); + } + catch (HttpRequestException e) + { + Console.WriteLine("\nException Caught!"); + Console.WriteLine("Message :{0} ", e.Message); + return null; + } + } + + } +} diff --git a/examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/Properties/AssemblyInfo.cs b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/Properties/AssemblyInfo.cs similarity index 97% rename from examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/Properties/AssemblyInfo.cs rename to examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/Properties/AssemblyInfo.cs index 88b93f01f..4ed97c8fc 100644 --- a/examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/Properties/AssemblyInfo.cs +++ b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/Properties/AssemblyInfo.cs @@ -1,36 +1,36 @@ -using System.Reflection; -using System.Runtime.CompilerServices; -using System.Runtime.InteropServices; - -// General Information about an assembly is controlled through the following -// set of attributes. Change these attribute values to modify the information -// associated with an assembly. -[assembly: AssemblyTitle("BaselineDll")] -[assembly: AssemblyDescription("")] -[assembly: AssemblyConfiguration("")] -[assembly: AssemblyCompany("")] -[assembly: AssemblyProduct("BaselineDll")] -[assembly: AssemblyCopyright("Copyright © 2020")] -[assembly: AssemblyTrademark("")] -[assembly: AssemblyCulture("")] - -// Setting ComVisible to false makes the types in this assembly not visible -// to COM components. If you need to access a type in this assembly from -// COM, set the ComVisible attribute to true on that type. -[assembly: ComVisible(false)] - -// The following GUID is for the ID of the typelib if this project is exposed to COM -[assembly: Guid("45dfb5fd-bc18-4c7d-ba97-0f5fe94bc88a")] - -// Version information for an assembly consists of the following four values: -// -// Major Version -// Minor Version -// Build Number -// Revision -// -// You can specify all the values or you can default the Build and Revision Numbers -// by using the '*' as shown below: -// [assembly: AssemblyVersion("1.0.*")] -[assembly: AssemblyVersion("1.0.0.0")] -[assembly: AssemblyFileVersion("1.0.0.0")] +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; + +// General Information about an assembly is controlled through the following +// set of attributes. Change these attribute values to modify the information +// associated with an assembly. +[assembly: AssemblyTitle("BaselineDll")] +[assembly: AssemblyDescription("")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("")] +[assembly: AssemblyProduct("BaselineDll")] +[assembly: AssemblyCopyright("Copyright © 2020")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +// Setting ComVisible to false makes the types in this assembly not visible +// to COM components. If you need to access a type in this assembly from +// COM, set the ComVisible attribute to true on that type. +[assembly: ComVisible(false)] + +// The following GUID is for the ID of the typelib if this project is exposed to COM +[assembly: Guid("45dfb5fd-bc18-4c7d-ba97-0f5fe94bc88a")] + +// Version information for an assembly consists of the following four values: +// +// Major Version +// Minor Version +// Build Number +// Revision +// +// You can specify all the values or you can default the Build and Revision Numbers +// by using the '*' as shown below: +// [assembly: AssemblyVersion("1.0.*")] +[assembly: AssemblyVersion("1.0.0.0")] +[assembly: AssemblyFileVersion("1.0.0.0")] diff --git a/examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/BaselineDll.csproj.FileListAbsolute.txt b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/BaselineDll.csproj.FileListAbsolute.txt similarity index 98% rename from examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/BaselineDll.csproj.FileListAbsolute.txt rename to examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/BaselineDll.csproj.FileListAbsolute.txt index d05294089..5cd6b330d 100644 --- a/examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/BaselineDll.csproj.FileListAbsolute.txt +++ b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/BaselineDll.csproj.FileListAbsolute.txt @@ -1,5 +1,5 @@ -C:\Users\d365admin\Desktop\BaselineDll\BaselineDll\bin\Debug\BaselineDll.dll -C:\Users\d365admin\Desktop\BaselineDll\BaselineDll\bin\Debug\BaselineDll.pdb -C:\Users\d365admin\Desktop\BaselineDll\BaselineDll\obj\Debug\BaselineDll.dll -C:\Users\d365admin\Desktop\BaselineDll\BaselineDll\obj\Debug\BaselineDll.pdb -C:\Users\d365admin\Desktop\BaselineDll\BaselineDll\obj\Debug\BaselineDll.csprojResolveAssemblyReference.cache +C:\Users\d365admin\Desktop\BaselineDll\BaselineDll\bin\Debug\BaselineDll.dll +C:\Users\d365admin\Desktop\BaselineDll\BaselineDll\bin\Debug\BaselineDll.pdb +C:\Users\d365admin\Desktop\BaselineDll\BaselineDll\obj\Debug\BaselineDll.dll +C:\Users\d365admin\Desktop\BaselineDll\BaselineDll\obj\Debug\BaselineDll.pdb +C:\Users\d365admin\Desktop\BaselineDll\BaselineDll\obj\Debug\BaselineDll.csprojResolveAssemblyReference.cache diff --git a/examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/BaselineDll.csprojResolveAssemblyReference.cache b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/BaselineDll.csprojResolveAssemblyReference.cache similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/BaselineDll.csprojResolveAssemblyReference.cache rename to examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/BaselineDll.csprojResolveAssemblyReference.cache diff --git a/examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/BaselineDll.dll b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/BaselineDll.dll similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/BaselineDll.dll rename to examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/BaselineDll.dll diff --git a/examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/BaselineDll.pdb b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/BaselineDll.pdb similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/BaselineDll.pdb rename to examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/BaselineDll.pdb diff --git a/examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache rename to examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineConnectorDll/obj/Debug/DesignTimeResolveAssemblyReferencesInput.cache diff --git a/examples/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/Baseline_JsonBuilder.xpp b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/Baseline_JsonBuilder.xpp similarity index 97% rename from examples/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/Baseline_JsonBuilder.xpp rename to examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/Baseline_JsonBuilder.xpp index cd94e3999..da11e4abf 100644 --- a/examples/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/Baseline_JsonBuilder.xpp +++ b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/Baseline_JsonBuilder.xpp @@ -1,193 +1,193 @@ -class Baseline_JsonBuilder -{ - public static str generateRFQJson(str rfqCaseId) - { - System.IO.StringWriter stringWriter; - Newtonsoft.Json.JsonTextWriter jsonWriter; - PurchRFQCaseTable rfqTable; - PurchRFQCaseLine rfqLine; - - stringWriter = new System.IO.StringWriter(); - jsonWriter = new Newtonsoft.Json.JsonTextWriter(stringWriter); - - select * from rfqTable - where rfqTable.RFQCaseId == rfqCaseId; - - str sJSON = ""; - jsonWriter.WriteStartObject(); - jsonWriter.WritePropertyName("RequestForProposalId"); - jsonWriter.WriteValue(rfqTable.RFQCaseId); - jsonWriter.WritePropertyName("SupplierId"); - jsonWriter.WriteValue("ACME GSheet"); - jsonWriter.WritePropertyName("BuyerId"); - jsonWriter.WriteValue("USMF - Contoso Entertainment System USA"); - jsonWriter.WritePropertyName("Items"); - jsonWriter.WriteStartArray(); - - while select * from rfqLine - where rfqLine.RFQCaseId == rfqCaseId - { - jsonWriter.WriteStartObject(); - - jsonWriter.WritePropertyName("OrderItemId"); - jsonWriter.WriteValue(rfqLine.LineNum); - jsonWriter.WritePropertyName("SKUBuyer"); - jsonWriter.WriteValue(rfqLine.ItemId); - jsonWriter.WritePropertyName("SKUSupplier"); - jsonWriter.WriteValue(rfqLine.ItemId); - jsonWriter.WritePropertyName("Quantity"); - jsonWriter.WriteValue(rfqLine.PurchQty); - jsonWriter.WritePropertyName("Unit"); - jsonWriter.WriteValue(rfqLine.PurchUnit); - jsonWriter.WritePropertyName("SinglePrice"); - jsonWriter.WriteValue(rfqLine.PurchPrice); - jsonWriter.WritePropertyName("TotalValue"); - jsonWriter.WriteValue(rfqLine.LineAmount); - jsonWriter.WritePropertyName("Currency"); - jsonWriter.WriteValue(rfqTable.CurrencyCode); - jsonWriter.WritePropertyName("EstimatedDeliveryDate"); - - utcdatetime lineDeliveryDate = DateTimeUtil::newDateTime(rfqLine.DeliveryDate, 0); - jsonWriter.WriteValue(DateTimeUtil::toStr(lineDeliveryDate)); - - jsonWriter.WriteEndObject(); - } - - jsonWriter.WriteEndArray(); - - jsonWriter.WritePropertyName("LatestDeliveryDate"); - - utcdatetime tableDeliveryDate = DateTimeUtil::newDateTime(rfqTable.DeliveryDate, 0); - jsonWriter.WriteValue(DateTimeUtil::toStr(tableDeliveryDate)); - - jsonWriter.WriteEndObject(); - - return stringWriter.ToString(); - } - - public static str generateMSAJson(str journalNum) - { - System.IO.StringWriter stringWriter; - Newtonsoft.Json.JsonTextWriter jsonWriter; - PriceDiscAdmTrans priceDiscTrans; - InventTable inventTable; - EcoResProduct ecoResProduct; - EcoResProductName productName; - - stringWriter = new System.IO.StringWriter(); - jsonWriter = new Newtonsoft.Json.JsonTextWriter(stringWriter); - - str sJSON = ""; - jsonWriter.WriteStartObject(); - jsonWriter.WritePropertyName("MasterServiceAgreementID"); - jsonWriter.WriteValue(journalNum); - jsonWriter.WritePropertyName("SupplierId"); - jsonWriter.WriteValue("ACME GSheet"); - jsonWriter.WritePropertyName("BuyerId"); - jsonWriter.WriteValue("USMF - Contoso Entertainment System USA"); - jsonWriter.WritePropertyName("SupplierBaselineIdentifier"); - jsonWriter.WriteValue("GoogleSheets"); - jsonWriter.WritePropertyName("BuyerBaselineIdentifier"); - jsonWriter.WriteValue("Dynamics365"); - jsonWriter.WritePropertyName("Skus"); - jsonWriter.WriteStartArray(); - - while select * from priceDiscTrans - where priceDiscTrans.JournalNum == journalNum - { - inventTable = InventTable::find(priceDiscTrans.itemId()); - productName = inventTable.productName(SystemParameters::getSystemLanguageId()); - - jsonWriter.WriteStartObject(); - - jsonWriter.WritePropertyName("ProductName"); - jsonWriter.WriteValue(productName); - jsonWriter.WritePropertyName("BuyerProductId"); - jsonWriter.WriteValue(priceDiscTrans.itemId()); - jsonWriter.WritePropertyName("SupplierProductId"); - jsonWriter.WriteValue(priceDiscTrans.itemId()); - - jsonWriter.WriteEndObject(); - } - - jsonWriter.WriteEndArray(); - - jsonWriter.WriteEndObject(); - - return stringWriter.ToString(); - } - - public static str generatePOJson(str purchId) - { - System.IO.StringWriter stringWriter; - Newtonsoft.Json.JsonTextWriter jsonWriter; - - stringWriter = new System.IO.StringWriter(); - jsonWriter = new Newtonsoft.Json.JsonTextWriter(stringWriter); - - PurchLine purchLine; - PriceDiscAdmTrans priceDiscTrans; - str referenceMsaId; - - str sJSON = ""; - jsonWriter.WriteStartObject(); - jsonWriter.WritePropertyName("PurchaseOrderId"); - jsonWriter.WriteValue(purchId); - jsonWriter.WritePropertyName("SupplierId"); - jsonWriter.WriteValue("ACME GSheet"); - jsonWriter.WritePropertyName("BuyerId"); - jsonWriter.WriteValue("USMF - Contoso Entertainment System USA"); - jsonWriter.WritePropertyName("ReferencedProposalId"); - jsonWriter.WriteValue(""); - jsonWriter.WritePropertyName("OrderItems"); - jsonWriter.WriteStartArray(); - - while select * from purchLine - where purchLine.PurchId == purchId - { - select firstonly JournalNum from priceDiscTrans - order by JournalNum desc - where priceDiscTrans.AccountRelation == purchLine.VendAccount - && priceDiscTrans.ItemRelation == purchLine.ItemId; - - referenceMsaId = priceDiscTrans.JournalNum; - - - jsonWriter.WriteStartObject(); - - jsonWriter.WritePropertyName("OrderItemId"); - jsonWriter.WriteValue(purchLine.LineNumber); - jsonWriter.WritePropertyName("SKUBuyer"); - jsonWriter.WriteValue(purchLine.ItemId); - jsonWriter.WritePropertyName("SKUSupplier"); - jsonWriter.WriteValue(purchLine.ItemId); - jsonWriter.WritePropertyName("Quantity"); - jsonWriter.WriteValue(purchLine.PurchQty); - jsonWriter.WritePropertyName("Unit"); - jsonWriter.WriteValue(purchLine.PurchUnit); - jsonWriter.WritePropertyName("SinglePrice"); - jsonWriter.WriteValue(purchLine.PurchPrice); - jsonWriter.WritePropertyName("TotalValue"); - jsonWriter.WriteValue(purchLine.LineAmount); - jsonWriter.WritePropertyName("Currency"); - jsonWriter.WriteValue(purchLine.CurrencyCode); - jsonWriter.WritePropertyName("EstimatedDeliveryDate"); - - utcdatetime lineDeliveryDate = DateTimeUtil::newDateTime(purchLine.DeliveryDate, 0); - jsonWriter.WriteValue(DateTimeUtil::toStr(lineDeliveryDate)); - - jsonWriter.WriteEndObject(); - } - - jsonWriter.WriteEndArray(); - - - jsonWriter.WritePropertyName("ReferencedMsaId"); - jsonWriter.WriteValue(referenceMsaId); - - jsonWriter.WriteEndObject(); - - return stringWriter.ToString(); - } - +class Baseline_JsonBuilder +{ + public static str generateRFQJson(str rfqCaseId) + { + System.IO.StringWriter stringWriter; + Newtonsoft.Json.JsonTextWriter jsonWriter; + PurchRFQCaseTable rfqTable; + PurchRFQCaseLine rfqLine; + + stringWriter = new System.IO.StringWriter(); + jsonWriter = new Newtonsoft.Json.JsonTextWriter(stringWriter); + + select * from rfqTable + where rfqTable.RFQCaseId == rfqCaseId; + + str sJSON = ""; + jsonWriter.WriteStartObject(); + jsonWriter.WritePropertyName("RequestForProposalId"); + jsonWriter.WriteValue(rfqTable.RFQCaseId); + jsonWriter.WritePropertyName("SupplierId"); + jsonWriter.WriteValue("ACME GSheet"); + jsonWriter.WritePropertyName("BuyerId"); + jsonWriter.WriteValue("USMF - Contoso Entertainment System USA"); + jsonWriter.WritePropertyName("Items"); + jsonWriter.WriteStartArray(); + + while select * from rfqLine + where rfqLine.RFQCaseId == rfqCaseId + { + jsonWriter.WriteStartObject(); + + jsonWriter.WritePropertyName("OrderItemId"); + jsonWriter.WriteValue(rfqLine.LineNum); + jsonWriter.WritePropertyName("SKUBuyer"); + jsonWriter.WriteValue(rfqLine.ItemId); + jsonWriter.WritePropertyName("SKUSupplier"); + jsonWriter.WriteValue(rfqLine.ItemId); + jsonWriter.WritePropertyName("Quantity"); + jsonWriter.WriteValue(rfqLine.PurchQty); + jsonWriter.WritePropertyName("Unit"); + jsonWriter.WriteValue(rfqLine.PurchUnit); + jsonWriter.WritePropertyName("SinglePrice"); + jsonWriter.WriteValue(rfqLine.PurchPrice); + jsonWriter.WritePropertyName("TotalValue"); + jsonWriter.WriteValue(rfqLine.LineAmount); + jsonWriter.WritePropertyName("Currency"); + jsonWriter.WriteValue(rfqTable.CurrencyCode); + jsonWriter.WritePropertyName("EstimatedDeliveryDate"); + + utcdatetime lineDeliveryDate = DateTimeUtil::newDateTime(rfqLine.DeliveryDate, 0); + jsonWriter.WriteValue(DateTimeUtil::toStr(lineDeliveryDate)); + + jsonWriter.WriteEndObject(); + } + + jsonWriter.WriteEndArray(); + + jsonWriter.WritePropertyName("LatestDeliveryDate"); + + utcdatetime tableDeliveryDate = DateTimeUtil::newDateTime(rfqTable.DeliveryDate, 0); + jsonWriter.WriteValue(DateTimeUtil::toStr(tableDeliveryDate)); + + jsonWriter.WriteEndObject(); + + return stringWriter.ToString(); + } + + public static str generateMSAJson(str journalNum) + { + System.IO.StringWriter stringWriter; + Newtonsoft.Json.JsonTextWriter jsonWriter; + PriceDiscAdmTrans priceDiscTrans; + InventTable inventTable; + EcoResProduct ecoResProduct; + EcoResProductName productName; + + stringWriter = new System.IO.StringWriter(); + jsonWriter = new Newtonsoft.Json.JsonTextWriter(stringWriter); + + str sJSON = ""; + jsonWriter.WriteStartObject(); + jsonWriter.WritePropertyName("MasterServiceAgreementID"); + jsonWriter.WriteValue(journalNum); + jsonWriter.WritePropertyName("SupplierId"); + jsonWriter.WriteValue("ACME GSheet"); + jsonWriter.WritePropertyName("BuyerId"); + jsonWriter.WriteValue("USMF - Contoso Entertainment System USA"); + jsonWriter.WritePropertyName("SupplierBaselineIdentifier"); + jsonWriter.WriteValue("GoogleSheets"); + jsonWriter.WritePropertyName("BuyerBaselineIdentifier"); + jsonWriter.WriteValue("Dynamics365"); + jsonWriter.WritePropertyName("Skus"); + jsonWriter.WriteStartArray(); + + while select * from priceDiscTrans + where priceDiscTrans.JournalNum == journalNum + { + inventTable = InventTable::find(priceDiscTrans.itemId()); + productName = inventTable.productName(SystemParameters::getSystemLanguageId()); + + jsonWriter.WriteStartObject(); + + jsonWriter.WritePropertyName("ProductName"); + jsonWriter.WriteValue(productName); + jsonWriter.WritePropertyName("BuyerProductId"); + jsonWriter.WriteValue(priceDiscTrans.itemId()); + jsonWriter.WritePropertyName("SupplierProductId"); + jsonWriter.WriteValue(priceDiscTrans.itemId()); + + jsonWriter.WriteEndObject(); + } + + jsonWriter.WriteEndArray(); + + jsonWriter.WriteEndObject(); + + return stringWriter.ToString(); + } + + public static str generatePOJson(str purchId) + { + System.IO.StringWriter stringWriter; + Newtonsoft.Json.JsonTextWriter jsonWriter; + + stringWriter = new System.IO.StringWriter(); + jsonWriter = new Newtonsoft.Json.JsonTextWriter(stringWriter); + + PurchLine purchLine; + PriceDiscAdmTrans priceDiscTrans; + str referenceMsaId; + + str sJSON = ""; + jsonWriter.WriteStartObject(); + jsonWriter.WritePropertyName("PurchaseOrderId"); + jsonWriter.WriteValue(purchId); + jsonWriter.WritePropertyName("SupplierId"); + jsonWriter.WriteValue("ACME GSheet"); + jsonWriter.WritePropertyName("BuyerId"); + jsonWriter.WriteValue("USMF - Contoso Entertainment System USA"); + jsonWriter.WritePropertyName("ReferencedProposalId"); + jsonWriter.WriteValue(""); + jsonWriter.WritePropertyName("OrderItems"); + jsonWriter.WriteStartArray(); + + while select * from purchLine + where purchLine.PurchId == purchId + { + select firstonly JournalNum from priceDiscTrans + order by JournalNum desc + where priceDiscTrans.AccountRelation == purchLine.VendAccount + && priceDiscTrans.ItemRelation == purchLine.ItemId; + + referenceMsaId = priceDiscTrans.JournalNum; + + + jsonWriter.WriteStartObject(); + + jsonWriter.WritePropertyName("OrderItemId"); + jsonWriter.WriteValue(purchLine.LineNumber); + jsonWriter.WritePropertyName("SKUBuyer"); + jsonWriter.WriteValue(purchLine.ItemId); + jsonWriter.WritePropertyName("SKUSupplier"); + jsonWriter.WriteValue(purchLine.ItemId); + jsonWriter.WritePropertyName("Quantity"); + jsonWriter.WriteValue(purchLine.PurchQty); + jsonWriter.WritePropertyName("Unit"); + jsonWriter.WriteValue(purchLine.PurchUnit); + jsonWriter.WritePropertyName("SinglePrice"); + jsonWriter.WriteValue(purchLine.PurchPrice); + jsonWriter.WritePropertyName("TotalValue"); + jsonWriter.WriteValue(purchLine.LineAmount); + jsonWriter.WritePropertyName("Currency"); + jsonWriter.WriteValue(purchLine.CurrencyCode); + jsonWriter.WritePropertyName("EstimatedDeliveryDate"); + + utcdatetime lineDeliveryDate = DateTimeUtil::newDateTime(purchLine.DeliveryDate, 0); + jsonWriter.WriteValue(DateTimeUtil::toStr(lineDeliveryDate)); + + jsonWriter.WriteEndObject(); + } + + jsonWriter.WriteEndArray(); + + + jsonWriter.WritePropertyName("ReferencedMsaId"); + jsonWriter.WriteValue(referenceMsaId); + + jsonWriter.WriteEndObject(); + + return stringWriter.ToString(); + } + } \ No newline at end of file diff --git a/examples/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/PriceDiscPost_EventHandler.xpp b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/PriceDiscPost_EventHandler.xpp similarity index 97% rename from examples/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/PriceDiscPost_EventHandler.xpp rename to examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/PriceDiscPost_EventHandler.xpp index f58d3e6ad..d3b76a87e 100644 --- a/examples/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/PriceDiscPost_EventHandler.xpp +++ b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/PriceDiscPost_EventHandler.xpp @@ -1,20 +1,20 @@ -class PriceDiscPost_EventHandler -{ - /// - /// - /// - /// - /// - [DataEventHandler(tableStr(PriceDiscAdmTable), DataEventType::Updating)] - public static void PriceDiscAdmTable_onUpdating(Common sender, DataEventArgs e) - { - PriceDiscAdmTable priceDiscTable = sender as PriceDiscAdmTable; - str agreementJson; - - if (priceDiscTable.Posted == NoYes::Yes) - { - agreementJson = Baseline_JsonBuilder::generateMSAJson(priceDiscTable.JournalNum); - BaselineDll.Integration::PostDocument(agreementJson, "msa"); - } - } +class PriceDiscPost_EventHandler +{ + /// + /// + /// + /// + /// + [DataEventHandler(tableStr(PriceDiscAdmTable), DataEventType::Updating)] + public static void PriceDiscAdmTable_onUpdating(Common sender, DataEventArgs e) + { + PriceDiscAdmTable priceDiscTable = sender as PriceDiscAdmTable; + str agreementJson; + + if (priceDiscTable.Posted == NoYes::Yes) + { + agreementJson = Baseline_JsonBuilder::generateMSAJson(priceDiscTable.JournalNum); + BaselineDll.Integration::PostDocument(agreementJson, "msa"); + } + } } \ No newline at end of file diff --git a/examples/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/PurchRFQSent_EventHandler.xpp b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/PurchRFQSent_EventHandler.xpp similarity index 96% rename from examples/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/PurchRFQSent_EventHandler.xpp rename to examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/PurchRFQSent_EventHandler.xpp index 91154b86b..138d8db22 100644 --- a/examples/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/PurchRFQSent_EventHandler.xpp +++ b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/PurchRFQSent_EventHandler.xpp @@ -1,24 +1,24 @@ -class PurchRFQSent_EventHandler -{ - /// - /// - /// - /// - /// - [DataEventHandler(tableStr(PurchRFQCaseTable), DataEventType::Updating)] - public static void PurchRFQCaseTable_onUpdating(Common sender, DataEventArgs e) - { - PurchRFQCaseTable rfqTable = sender as PurchRFQCaseTable; - str rfqJson; - - if (rfqTable.StatusHigh == PurchRFQStatus::Sent && rfqTable.IsSentToBaseline == NoYes::No) - { - rfqJson = Baseline_JsonBuilder::generateRFQJson(rfqTable.RFQCaseId); - - BaselineDll.Integration::PostDocument(rfqJson, "rfq"); - - rfqTable.IsSentToBaseline = NoYes::Yes; - } - } - +class PurchRFQSent_EventHandler +{ + /// + /// + /// + /// + /// + [DataEventHandler(tableStr(PurchRFQCaseTable), DataEventType::Updating)] + public static void PurchRFQCaseTable_onUpdating(Common sender, DataEventArgs e) + { + PurchRFQCaseTable rfqTable = sender as PurchRFQCaseTable; + str rfqJson; + + if (rfqTable.StatusHigh == PurchRFQStatus::Sent && rfqTable.IsSentToBaseline == NoYes::No) + { + rfqJson = Baseline_JsonBuilder::generateRFQJson(rfqTable.RFQCaseId); + + BaselineDll.Integration::PostDocument(rfqJson, "rfq"); + + rfqTable.IsSentToBaseline = NoYes::Yes; + } + } + } \ No newline at end of file diff --git a/examples/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/PurchaseOrderConfirm_EventHandler.xpp b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/PurchaseOrderConfirm_EventHandler.xpp similarity index 97% rename from examples/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/PurchaseOrderConfirm_EventHandler.xpp rename to examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/PurchaseOrderConfirm_EventHandler.xpp index 5f88b5aa9..038d59749 100644 --- a/examples/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/PurchaseOrderConfirm_EventHandler.xpp +++ b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/BaselineDynamicsExtensions/PurchaseOrderConfirm_EventHandler.xpp @@ -1,23 +1,23 @@ -class PurchaseOrderConfirm_EventHandler -{ - /// - /// - /// - /// - /// - [FormControlEventHandler(formControlStr(PurchTable, buttonConfirm), FormControlEventType::Clicked)] - public static void buttonConfirm_OnClicked(FormControl sender, FormControlEventArgs e) - { - FormRun form = sender.formRun() as FormRun; - FormDataSource purchTable_ds = sender.formRun().dataSource(1); - - PurchTable purchTable = purchTable_ds.cursor(); - - str purchaseOrderJson; - - purchaseOrderJson = Baseline_JsonBuilder::generatePOJson(purchTable.PurchId); - - BaselineDll.Integration::PostDocument(purchaseOrderJson, "po"); - } - +class PurchaseOrderConfirm_EventHandler +{ + /// + /// + /// + /// + /// + [FormControlEventHandler(formControlStr(PurchTable, buttonConfirm), FormControlEventType::Clicked)] + public static void buttonConfirm_OnClicked(FormControl sender, FormControlEventArgs e) + { + FormRun form = sender.formRun() as FormRun; + FormDataSource purchTable_ds = sender.formRun().dataSource(1); + + PurchTable purchTable = purchTable_ds.cursor(); + + str purchaseOrderJson; + + purchaseOrderJson = Baseline_JsonBuilder::generatePOJson(purchTable.PurchId); + + BaselineDll.Integration::PostDocument(purchaseOrderJson, "po"); + } + } \ No newline at end of file diff --git a/examples/bri-1/lib/google-sheets-connector/d365/README.md b/examples/deprecated/bri-1/lib/google-sheets-connector/d365/README.md similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/d365/README.md rename to examples/deprecated/bri-1/lib/google-sheets-connector/d365/README.md diff --git a/examples/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/Readme.md b/examples/deprecated/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/Readme.md similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/Readme.md rename to examples/deprecated/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/Readme.md diff --git a/examples/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/api_key.json b/examples/deprecated/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/api_key.json similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/api_key.json rename to examples/deprecated/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/api_key.json diff --git a/examples/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/credentials.json b/examples/deprecated/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/credentials.json similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/credentials.json rename to examples/deprecated/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/credentials.json diff --git a/examples/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/function.go b/examples/deprecated/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/function.go similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/function.go rename to examples/deprecated/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/function.go diff --git a/examples/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/go.mod b/examples/deprecated/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/go.mod similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/go.mod rename to examples/deprecated/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/go.mod diff --git a/examples/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/go.sum b/examples/deprecated/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/go.sum similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/go.sum rename to examples/deprecated/bri-1/lib/google-sheets-connector/google-sheets/cloud-functions/go.sum diff --git a/examples/bri-1/lib/google-sheets-connector/google-sheets/sheets-add-on/sidebar.gs b/examples/deprecated/bri-1/lib/google-sheets-connector/google-sheets/sheets-add-on/sidebar.gs similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/google-sheets/sheets-add-on/sidebar.gs rename to examples/deprecated/bri-1/lib/google-sheets-connector/google-sheets/sheets-add-on/sidebar.gs diff --git a/examples/bri-1/lib/google-sheets-connector/google-sheets/sheets-add-on/test-sidebar.html b/examples/deprecated/bri-1/lib/google-sheets-connector/google-sheets/sheets-add-on/test-sidebar.html similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/google-sheets/sheets-add-on/test-sidebar.html rename to examples/deprecated/bri-1/lib/google-sheets-connector/google-sheets/sheets-add-on/test-sidebar.html diff --git a/examples/bri-1/lib/google-sheets-connector/images/dynamics.png b/examples/deprecated/bri-1/lib/google-sheets-connector/images/dynamics.png similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/images/dynamics.png rename to examples/deprecated/bri-1/lib/google-sheets-connector/images/dynamics.png diff --git a/examples/bri-1/lib/google-sheets-connector/images/sequence-diagram.png b/examples/deprecated/bri-1/lib/google-sheets-connector/images/sequence-diagram.png similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/images/sequence-diagram.png rename to examples/deprecated/bri-1/lib/google-sheets-connector/images/sequence-diagram.png diff --git a/examples/bri-1/lib/google-sheets-connector/images/sheets.png b/examples/deprecated/bri-1/lib/google-sheets-connector/images/sheets.png similarity index 100% rename from examples/bri-1/lib/google-sheets-connector/images/sheets.png rename to examples/deprecated/bri-1/lib/google-sheets-connector/images/sheets.png diff --git a/examples/bri-2/.gitignore b/examples/deprecated/bri-2/.gitignore similarity index 100% rename from examples/bri-2/.gitignore rename to examples/deprecated/bri-2/.gitignore diff --git a/examples/bri-2/.npmignore b/examples/deprecated/bri-2/.npmignore similarity index 100% rename from examples/bri-2/.npmignore rename to examples/deprecated/bri-2/.npmignore diff --git a/examples/bri-2/.nvmrc b/examples/deprecated/bri-2/.nvmrc similarity index 100% rename from examples/bri-2/.nvmrc rename to examples/deprecated/bri-2/.nvmrc diff --git a/examples/bri-2/.prettierrc b/examples/deprecated/bri-2/.prettierrc similarity index 100% rename from examples/bri-2/.prettierrc rename to examples/deprecated/bri-2/.prettierrc diff --git a/examples/bri-2/Makefile b/examples/deprecated/bri-2/Makefile similarity index 100% rename from examples/bri-2/Makefile rename to examples/deprecated/bri-2/Makefile diff --git a/examples/bri-2/README.md b/examples/deprecated/bri-2/README.md similarity index 100% rename from examples/bri-2/README.md rename to examples/deprecated/bri-2/README.md diff --git a/examples/bri-2/besu/config.toml b/examples/deprecated/bri-2/besu/config.toml similarity index 100% rename from examples/bri-2/besu/config.toml rename to examples/deprecated/bri-2/besu/config.toml diff --git a/examples/bri-2/besu/genesis.json b/examples/deprecated/bri-2/besu/genesis.json similarity index 100% rename from examples/bri-2/besu/genesis.json rename to examples/deprecated/bri-2/besu/genesis.json diff --git a/examples/bri-2/besu/key b/examples/deprecated/bri-2/besu/key similarity index 100% rename from examples/bri-2/besu/key rename to examples/deprecated/bri-2/besu/key diff --git a/examples/bri-2/besu/log-config.xml b/examples/deprecated/bri-2/besu/log-config.xml similarity index 100% rename from examples/bri-2/besu/log-config.xml rename to examples/deprecated/bri-2/besu/log-config.xml diff --git a/examples/bri-2/commit-mgr/.dockerignore b/examples/deprecated/bri-2/commit-mgr/.dockerignore similarity index 100% rename from examples/bri-2/commit-mgr/.dockerignore rename to examples/deprecated/bri-2/commit-mgr/.dockerignore diff --git a/examples/bri-2/commit-mgr/.env_example b/examples/deprecated/bri-2/commit-mgr/.env_example similarity index 100% rename from examples/bri-2/commit-mgr/.env_example rename to examples/deprecated/bri-2/commit-mgr/.env_example diff --git a/examples/bri-2/commit-mgr/.gitignore b/examples/deprecated/bri-2/commit-mgr/.gitignore similarity index 100% rename from examples/bri-2/commit-mgr/.gitignore rename to examples/deprecated/bri-2/commit-mgr/.gitignore diff --git a/examples/bri-2/commit-mgr/.nvmrc b/examples/deprecated/bri-2/commit-mgr/.nvmrc similarity index 100% rename from examples/bri-2/commit-mgr/.nvmrc rename to examples/deprecated/bri-2/commit-mgr/.nvmrc diff --git a/examples/bri-2/commit-mgr/Dockerfile b/examples/deprecated/bri-2/commit-mgr/Dockerfile similarity index 100% rename from examples/bri-2/commit-mgr/Dockerfile rename to examples/deprecated/bri-2/commit-mgr/Dockerfile diff --git a/examples/bri-2/commit-mgr/README.md b/examples/deprecated/bri-2/commit-mgr/README.md similarity index 100% rename from examples/bri-2/commit-mgr/README.md rename to examples/deprecated/bri-2/commit-mgr/README.md diff --git a/examples/bri-2/commit-mgr/jest.config.js b/examples/deprecated/bri-2/commit-mgr/jest.config.js similarity index 100% rename from examples/bri-2/commit-mgr/jest.config.js rename to examples/deprecated/bri-2/commit-mgr/jest.config.js diff --git a/examples/bri-2/commit-mgr/package-lock.json b/examples/deprecated/bri-2/commit-mgr/package-lock.json similarity index 100% rename from examples/bri-2/commit-mgr/package-lock.json rename to examples/deprecated/bri-2/commit-mgr/package-lock.json diff --git a/examples/bri-2/commit-mgr/package.json b/examples/deprecated/bri-2/commit-mgr/package.json similarity index 100% rename from examples/bri-2/commit-mgr/package.json rename to examples/deprecated/bri-2/commit-mgr/package.json diff --git a/examples/bri-2/commit-mgr/src/blockchain/contracts/Shield.json b/examples/deprecated/bri-2/commit-mgr/src/blockchain/contracts/Shield.json similarity index 100% rename from examples/bri-2/commit-mgr/src/blockchain/contracts/Shield.json rename to examples/deprecated/bri-2/commit-mgr/src/blockchain/contracts/Shield.json diff --git a/examples/bri-2/commit-mgr/src/blockchain/contracts/VerifierNoop.json b/examples/deprecated/bri-2/commit-mgr/src/blockchain/contracts/VerifierNoop.json similarity index 100% rename from examples/bri-2/commit-mgr/src/blockchain/contracts/VerifierNoop.json rename to examples/deprecated/bri-2/commit-mgr/src/blockchain/contracts/VerifierNoop.json diff --git a/examples/bri-2/commit-mgr/src/blockchain/contracts/index.js b/examples/deprecated/bri-2/commit-mgr/src/blockchain/contracts/index.js similarity index 100% rename from examples/bri-2/commit-mgr/src/blockchain/contracts/index.js rename to examples/deprecated/bri-2/commit-mgr/src/blockchain/contracts/index.js diff --git a/examples/bri-2/commit-mgr/src/blockchain/events.js b/examples/deprecated/bri-2/commit-mgr/src/blockchain/events.js similarity index 100% rename from examples/bri-2/commit-mgr/src/blockchain/events.js rename to examples/deprecated/bri-2/commit-mgr/src/blockchain/events.js diff --git a/examples/bri-2/commit-mgr/src/blockchain/index.js b/examples/deprecated/bri-2/commit-mgr/src/blockchain/index.js similarity index 100% rename from examples/bri-2/commit-mgr/src/blockchain/index.js rename to examples/deprecated/bri-2/commit-mgr/src/blockchain/index.js diff --git a/examples/bri-2/commit-mgr/src/blockchain/utils.js b/examples/deprecated/bri-2/commit-mgr/src/blockchain/utils.js similarity index 100% rename from examples/bri-2/commit-mgr/src/blockchain/utils.js rename to examples/deprecated/bri-2/commit-mgr/src/blockchain/utils.js diff --git a/examples/bri-2/commit-mgr/src/db/index.js b/examples/deprecated/bri-2/commit-mgr/src/db/index.js similarity index 100% rename from examples/bri-2/commit-mgr/src/db/index.js rename to examples/deprecated/bri-2/commit-mgr/src/db/index.js diff --git a/examples/bri-2/commit-mgr/src/db/models/Commit.js b/examples/deprecated/bri-2/commit-mgr/src/db/models/Commit.js similarity index 100% rename from examples/bri-2/commit-mgr/src/db/models/Commit.js rename to examples/deprecated/bri-2/commit-mgr/src/db/models/Commit.js diff --git a/examples/bri-2/commit-mgr/src/db/models/Contract.js b/examples/deprecated/bri-2/commit-mgr/src/db/models/Contract.js similarity index 100% rename from examples/bri-2/commit-mgr/src/db/models/Contract.js rename to examples/deprecated/bri-2/commit-mgr/src/db/models/Contract.js diff --git a/examples/bri-2/commit-mgr/src/db/models/MerkleTree.js b/examples/deprecated/bri-2/commit-mgr/src/db/models/MerkleTree.js similarity index 100% rename from examples/bri-2/commit-mgr/src/db/models/MerkleTree.js rename to examples/deprecated/bri-2/commit-mgr/src/db/models/MerkleTree.js diff --git a/examples/bri-2/commit-mgr/src/index.ts b/examples/deprecated/bri-2/commit-mgr/src/index.ts similarity index 100% rename from examples/bri-2/commit-mgr/src/index.ts rename to examples/deprecated/bri-2/commit-mgr/src/index.ts diff --git a/examples/bri-2/commit-mgr/src/logger/format.ts b/examples/deprecated/bri-2/commit-mgr/src/logger/format.ts similarity index 100% rename from examples/bri-2/commit-mgr/src/logger/format.ts rename to examples/deprecated/bri-2/commit-mgr/src/logger/format.ts diff --git a/examples/bri-2/commit-mgr/src/logger/index.ts b/examples/deprecated/bri-2/commit-mgr/src/logger/index.ts similarity index 100% rename from examples/bri-2/commit-mgr/src/logger/index.ts rename to examples/deprecated/bri-2/commit-mgr/src/logger/index.ts diff --git a/examples/bri-2/commit-mgr/src/logger/static.ts b/examples/deprecated/bri-2/commit-mgr/src/logger/static.ts similarity index 100% rename from examples/bri-2/commit-mgr/src/logger/static.ts rename to examples/deprecated/bri-2/commit-mgr/src/logger/static.ts diff --git a/examples/bri-2/commit-mgr/src/merkle-tree/config.ts b/examples/deprecated/bri-2/commit-mgr/src/merkle-tree/config.ts similarity index 100% rename from examples/bri-2/commit-mgr/src/merkle-tree/config.ts rename to examples/deprecated/bri-2/commit-mgr/src/merkle-tree/config.ts diff --git a/examples/bri-2/commit-mgr/src/merkle-tree/hash.js b/examples/deprecated/bri-2/commit-mgr/src/merkle-tree/hash.js similarity index 100% rename from examples/bri-2/commit-mgr/src/merkle-tree/hash.js rename to examples/deprecated/bri-2/commit-mgr/src/merkle-tree/hash.js diff --git a/examples/bri-2/commit-mgr/src/merkle-tree/index.js b/examples/deprecated/bri-2/commit-mgr/src/merkle-tree/index.js similarity index 100% rename from examples/bri-2/commit-mgr/src/merkle-tree/index.js rename to examples/deprecated/bri-2/commit-mgr/src/merkle-tree/index.js diff --git a/examples/bri-2/commit-mgr/src/merkle-tree/leaves.js b/examples/deprecated/bri-2/commit-mgr/src/merkle-tree/leaves.js similarity index 100% rename from examples/bri-2/commit-mgr/src/merkle-tree/leaves.js rename to examples/deprecated/bri-2/commit-mgr/src/merkle-tree/leaves.js diff --git a/examples/bri-2/commit-mgr/src/merkle-tree/utils.js b/examples/deprecated/bri-2/commit-mgr/src/merkle-tree/utils.js similarity index 100% rename from examples/bri-2/commit-mgr/src/merkle-tree/utils.js rename to examples/deprecated/bri-2/commit-mgr/src/merkle-tree/utils.js diff --git a/examples/bri-2/commit-mgr/src/nats/index.js b/examples/deprecated/bri-2/commit-mgr/src/nats/index.js similarity index 100% rename from examples/bri-2/commit-mgr/src/nats/index.js rename to examples/deprecated/bri-2/commit-mgr/src/nats/index.js diff --git a/examples/bri-2/commit-mgr/src/nats/workflow-mgr.js b/examples/deprecated/bri-2/commit-mgr/src/nats/workflow-mgr.js similarity index 100% rename from examples/bri-2/commit-mgr/src/nats/workflow-mgr.js rename to examples/deprecated/bri-2/commit-mgr/src/nats/workflow-mgr.js diff --git a/examples/bri-2/commit-mgr/src/route-handlers/rest-methods.ts b/examples/deprecated/bri-2/commit-mgr/src/route-handlers/rest-methods.ts similarity index 100% rename from examples/bri-2/commit-mgr/src/route-handlers/rest-methods.ts rename to examples/deprecated/bri-2/commit-mgr/src/route-handlers/rest-methods.ts diff --git a/examples/bri-2/commit-mgr/src/route-handlers/rpc-methods.ts b/examples/deprecated/bri-2/commit-mgr/src/route-handlers/rpc-methods.ts similarity index 100% rename from examples/bri-2/commit-mgr/src/route-handlers/rpc-methods.ts rename to examples/deprecated/bri-2/commit-mgr/src/route-handlers/rpc-methods.ts diff --git a/examples/bri-2/commit-mgr/src/rpc-server.ts b/examples/deprecated/bri-2/commit-mgr/src/rpc-server.ts similarity index 100% rename from examples/bri-2/commit-mgr/src/rpc-server.ts rename to examples/deprecated/bri-2/commit-mgr/src/rpc-server.ts diff --git a/examples/bri-2/commit-mgr/src/tx-manager/eth-client.ts b/examples/deprecated/bri-2/commit-mgr/src/tx-manager/eth-client.ts similarity index 100% rename from examples/bri-2/commit-mgr/src/tx-manager/eth-client.ts rename to examples/deprecated/bri-2/commit-mgr/src/tx-manager/eth-client.ts diff --git a/examples/bri-2/commit-mgr/src/tx-manager/index.ts b/examples/deprecated/bri-2/commit-mgr/src/tx-manager/index.ts similarity index 100% rename from examples/bri-2/commit-mgr/src/tx-manager/index.ts rename to examples/deprecated/bri-2/commit-mgr/src/tx-manager/index.ts diff --git a/examples/bri-2/commit-mgr/src/tx-manager/infura-gas.ts b/examples/deprecated/bri-2/commit-mgr/src/tx-manager/infura-gas.ts similarity index 100% rename from examples/bri-2/commit-mgr/src/tx-manager/infura-gas.ts rename to examples/deprecated/bri-2/commit-mgr/src/tx-manager/infura-gas.ts diff --git a/examples/bri-2/commit-mgr/src/tx-manager/local-db.ts b/examples/deprecated/bri-2/commit-mgr/src/tx-manager/local-db.ts similarity index 100% rename from examples/bri-2/commit-mgr/src/tx-manager/local-db.ts rename to examples/deprecated/bri-2/commit-mgr/src/tx-manager/local-db.ts diff --git a/examples/bri-2/commit-mgr/src/utils/index.js b/examples/deprecated/bri-2/commit-mgr/src/utils/index.js similarity index 100% rename from examples/bri-2/commit-mgr/src/utils/index.js rename to examples/deprecated/bri-2/commit-mgr/src/utils/index.js diff --git a/examples/bri-2/commit-mgr/tests/commit-mgr.postman_collection.json b/examples/deprecated/bri-2/commit-mgr/tests/commit-mgr.postman_collection.json similarity index 100% rename from examples/bri-2/commit-mgr/tests/commit-mgr.postman_collection.json rename to examples/deprecated/bri-2/commit-mgr/tests/commit-mgr.postman_collection.json diff --git a/examples/bri-2/commit-mgr/tests/jsonrpc.test.js b/examples/deprecated/bri-2/commit-mgr/tests/jsonrpc.test.js similarity index 100% rename from examples/bri-2/commit-mgr/tests/jsonrpc.test.js rename to examples/deprecated/bri-2/commit-mgr/tests/jsonrpc.test.js diff --git a/examples/bri-2/commit-mgr/tests/utils.js b/examples/deprecated/bri-2/commit-mgr/tests/utils.js similarity index 100% rename from examples/bri-2/commit-mgr/tests/utils.js rename to examples/deprecated/bri-2/commit-mgr/tests/utils.js diff --git a/examples/bri-2/commit-mgr/tsconfig.json b/examples/deprecated/bri-2/commit-mgr/tsconfig.json similarity index 100% rename from examples/bri-2/commit-mgr/tsconfig.json rename to examples/deprecated/bri-2/commit-mgr/tsconfig.json diff --git a/examples/bri-2/commit-mgr/tslint.json b/examples/deprecated/bri-2/commit-mgr/tslint.json similarity index 100% rename from examples/bri-2/commit-mgr/tslint.json rename to examples/deprecated/bri-2/commit-mgr/tslint.json diff --git a/examples/bri-2/contracts/contracts/privacy/IShield.sol b/examples/deprecated/bri-2/contracts/contracts/privacy/IShield.sol similarity index 100% rename from examples/bri-2/contracts/contracts/privacy/IShield.sol rename to examples/deprecated/bri-2/contracts/contracts/privacy/IShield.sol diff --git a/examples/bri-2/contracts/contracts/privacy/IVerifier.sol b/examples/deprecated/bri-2/contracts/contracts/privacy/IVerifier.sol similarity index 100% rename from examples/bri-2/contracts/contracts/privacy/IVerifier.sol rename to examples/deprecated/bri-2/contracts/contracts/privacy/IVerifier.sol diff --git a/examples/bri-2/contracts/contracts/privacy/Shield.sol b/examples/deprecated/bri-2/contracts/contracts/privacy/Shield.sol similarity index 100% rename from examples/bri-2/contracts/contracts/privacy/Shield.sol rename to examples/deprecated/bri-2/contracts/contracts/privacy/Shield.sol diff --git a/examples/bri-2/contracts/contracts/privacy/lib/MerkleTreeSHA256.sol b/examples/deprecated/bri-2/contracts/contracts/privacy/lib/MerkleTreeSHA256.sol similarity index 100% rename from examples/bri-2/contracts/contracts/privacy/lib/MerkleTreeSHA256.sol rename to examples/deprecated/bri-2/contracts/contracts/privacy/lib/MerkleTreeSHA256.sol diff --git a/examples/bri-2/contracts/contracts/privacy/lib/VerifierNoop.sol b/examples/deprecated/bri-2/contracts/contracts/privacy/lib/VerifierNoop.sol similarity index 100% rename from examples/bri-2/contracts/contracts/privacy/lib/VerifierNoop.sol rename to examples/deprecated/bri-2/contracts/contracts/privacy/lib/VerifierNoop.sol diff --git a/examples/bri-2/dashboard/.github/workflows/main.yml b/examples/deprecated/bri-2/dashboard/.github/workflows/main.yml similarity index 100% rename from examples/bri-2/dashboard/.github/workflows/main.yml rename to examples/deprecated/bri-2/dashboard/.github/workflows/main.yml diff --git a/examples/bri-2/dashboard/.gitignore b/examples/deprecated/bri-2/dashboard/.gitignore similarity index 100% rename from examples/bri-2/dashboard/.gitignore rename to examples/deprecated/bri-2/dashboard/.gitignore diff --git a/examples/bri-2/dashboard/.nvmrc b/examples/deprecated/bri-2/dashboard/.nvmrc similarity index 100% rename from examples/bri-2/dashboard/.nvmrc rename to examples/deprecated/bri-2/dashboard/.nvmrc diff --git a/examples/bri-2/dashboard/CHANGELOG.md b/examples/deprecated/bri-2/dashboard/CHANGELOG.md similarity index 100% rename from examples/bri-2/dashboard/CHANGELOG.md rename to examples/deprecated/bri-2/dashboard/CHANGELOG.md diff --git a/examples/bri-2/dashboard/Dockerfile b/examples/deprecated/bri-2/dashboard/Dockerfile old mode 100755 new mode 100644 similarity index 100% rename from examples/bri-2/dashboard/Dockerfile rename to examples/deprecated/bri-2/dashboard/Dockerfile diff --git a/examples/bri-2/dashboard/README.md b/examples/deprecated/bri-2/dashboard/README.md similarity index 100% rename from examples/bri-2/dashboard/README.md rename to examples/deprecated/bri-2/dashboard/README.md diff --git a/examples/bri-2/dashboard/assets/img/angular.jpg b/examples/deprecated/bri-2/dashboard/assets/img/angular.jpg similarity index 100% rename from examples/bri-2/dashboard/assets/img/angular.jpg rename to examples/deprecated/bri-2/dashboard/assets/img/angular.jpg diff --git a/examples/bri-2/dashboard/assets/img/baselineHorizontal-Logo-Full-Color.png b/examples/deprecated/bri-2/dashboard/assets/img/baselineHorizontal-Logo-Full-Color.png similarity index 100% rename from examples/bri-2/dashboard/assets/img/baselineHorizontal-Logo-Full-Color.png rename to examples/deprecated/bri-2/dashboard/assets/img/baselineHorizontal-Logo-Full-Color.png diff --git a/examples/bri-2/dashboard/assets/img/baselineHorizontal-Logo-Full-Color.svg b/examples/deprecated/bri-2/dashboard/assets/img/baselineHorizontal-Logo-Full-Color.svg similarity index 100% rename from examples/bri-2/dashboard/assets/img/baselineHorizontal-Logo-Full-Color.svg rename to examples/deprecated/bri-2/dashboard/assets/img/baselineHorizontal-Logo-Full-Color.svg diff --git a/examples/bri-2/dashboard/assets/img/baselineLogoMark-All-White.png b/examples/deprecated/bri-2/dashboard/assets/img/baselineLogoMark-All-White.png similarity index 100% rename from examples/bri-2/dashboard/assets/img/baselineLogoMark-All-White.png rename to examples/deprecated/bri-2/dashboard/assets/img/baselineLogoMark-All-White.png diff --git a/examples/bri-2/dashboard/assets/img/baseline_Horizontal-Logo-allWhite.svg b/examples/deprecated/bri-2/dashboard/assets/img/baseline_Horizontal-Logo-allWhite.svg similarity index 100% rename from examples/bri-2/dashboard/assets/img/baseline_Horizontal-Logo-allWhite.svg rename to examples/deprecated/bri-2/dashboard/assets/img/baseline_Horizontal-Logo-allWhite.svg diff --git a/examples/bri-2/dashboard/assets/img/bootstrap.jpg b/examples/deprecated/bri-2/dashboard/assets/img/bootstrap.jpg similarity index 100% rename from examples/bri-2/dashboard/assets/img/bootstrap.jpg rename to examples/deprecated/bri-2/dashboard/assets/img/bootstrap.jpg diff --git a/examples/bri-2/dashboard/assets/img/brand/apple-icon.png b/examples/deprecated/bri-2/dashboard/assets/img/brand/apple-icon.png similarity index 100% rename from examples/bri-2/dashboard/assets/img/brand/apple-icon.png rename to examples/deprecated/bri-2/dashboard/assets/img/brand/apple-icon.png diff --git a/examples/bri-2/dashboard/assets/img/brand/baselineHorizontal-Logo-DarkBackground.png b/examples/deprecated/bri-2/dashboard/assets/img/brand/baselineHorizontal-Logo-DarkBackground.png similarity index 100% rename from examples/bri-2/dashboard/assets/img/brand/baselineHorizontal-Logo-DarkBackground.png rename to examples/deprecated/bri-2/dashboard/assets/img/brand/baselineHorizontal-Logo-DarkBackground.png diff --git a/examples/bri-2/dashboard/assets/img/brand/baselineLogoMark-All-White.png b/examples/deprecated/bri-2/dashboard/assets/img/brand/baselineLogoMark-All-White.png similarity index 100% rename from examples/bri-2/dashboard/assets/img/brand/baselineLogoMark-All-White.png rename to examples/deprecated/bri-2/dashboard/assets/img/brand/baselineLogoMark-All-White.png diff --git a/examples/bri-2/dashboard/assets/img/brand/baselineLogoMark-FullColor.png b/examples/deprecated/bri-2/dashboard/assets/img/brand/baselineLogoMark-FullColor.png old mode 100755 new mode 100644 similarity index 100% rename from examples/bri-2/dashboard/assets/img/brand/baselineLogoMark-FullColor.png rename to examples/deprecated/bri-2/dashboard/assets/img/brand/baselineLogoMark-FullColor.png diff --git a/examples/bri-2/dashboard/assets/img/brand/baseline_Horizontal-Logo-allWhite.svg b/examples/deprecated/bri-2/dashboard/assets/img/brand/baseline_Horizontal-Logo-allWhite.svg similarity index 100% rename from examples/bri-2/dashboard/assets/img/brand/baseline_Horizontal-Logo-allWhite.svg rename to examples/deprecated/bri-2/dashboard/assets/img/brand/baseline_Horizontal-Logo-allWhite.svg diff --git a/examples/bri-2/dashboard/assets/img/brand/favicon.ico b/examples/deprecated/bri-2/dashboard/assets/img/brand/favicon.ico similarity index 100% rename from examples/bri-2/dashboard/assets/img/brand/favicon.ico rename to examples/deprecated/bri-2/dashboard/assets/img/brand/favicon.ico diff --git a/examples/bri-2/dashboard/assets/img/component-btn-pink.png b/examples/deprecated/bri-2/dashboard/assets/img/component-btn-pink.png similarity index 100% rename from examples/bri-2/dashboard/assets/img/component-btn-pink.png rename to examples/deprecated/bri-2/dashboard/assets/img/component-btn-pink.png diff --git a/examples/bri-2/dashboard/assets/img/component-btn.png b/examples/deprecated/bri-2/dashboard/assets/img/component-btn.png similarity index 100% rename from examples/bri-2/dashboard/assets/img/component-btn.png rename to examples/deprecated/bri-2/dashboard/assets/img/component-btn.png diff --git a/examples/bri-2/dashboard/assets/img/component-info-2.png b/examples/deprecated/bri-2/dashboard/assets/img/component-info-2.png similarity index 100% rename from examples/bri-2/dashboard/assets/img/component-info-2.png rename to examples/deprecated/bri-2/dashboard/assets/img/component-info-2.png diff --git a/examples/bri-2/dashboard/assets/img/component-info-card.png b/examples/deprecated/bri-2/dashboard/assets/img/component-info-card.png similarity index 100% rename from examples/bri-2/dashboard/assets/img/component-info-card.png rename to examples/deprecated/bri-2/dashboard/assets/img/component-info-card.png diff --git a/examples/bri-2/dashboard/assets/img/component-menu.png b/examples/deprecated/bri-2/dashboard/assets/img/component-menu.png similarity index 100% rename from examples/bri-2/dashboard/assets/img/component-menu.png rename to examples/deprecated/bri-2/dashboard/assets/img/component-menu.png diff --git a/examples/bri-2/dashboard/assets/img/component-profile-card.png b/examples/deprecated/bri-2/dashboard/assets/img/component-profile-card.png similarity index 100% rename from examples/bri-2/dashboard/assets/img/component-profile-card.png rename to examples/deprecated/bri-2/dashboard/assets/img/component-profile-card.png diff --git a/examples/bri-2/dashboard/assets/img/documentation.png b/examples/deprecated/bri-2/dashboard/assets/img/documentation.png similarity index 100% rename from examples/bri-2/dashboard/assets/img/documentation.png rename to examples/deprecated/bri-2/dashboard/assets/img/documentation.png diff --git a/examples/bri-2/dashboard/assets/img/favicon-16x16.png b/examples/deprecated/bri-2/dashboard/assets/img/favicon-16x16.png similarity index 100% rename from examples/bri-2/dashboard/assets/img/favicon-16x16.png rename to examples/deprecated/bri-2/dashboard/assets/img/favicon-16x16.png diff --git a/examples/bri-2/dashboard/assets/img/favicon-32x32.png b/examples/deprecated/bri-2/dashboard/assets/img/favicon-32x32.png similarity index 100% rename from examples/bri-2/dashboard/assets/img/favicon-32x32.png rename to examples/deprecated/bri-2/dashboard/assets/img/favicon-32x32.png diff --git a/examples/bri-2/dashboard/assets/img/favicon.ico b/examples/deprecated/bri-2/dashboard/assets/img/favicon.ico similarity index 100% rename from examples/bri-2/dashboard/assets/img/favicon.ico rename to examples/deprecated/bri-2/dashboard/assets/img/favicon.ico diff --git a/examples/bri-2/dashboard/assets/img/github.svg b/examples/deprecated/bri-2/dashboard/assets/img/github.svg similarity index 100% rename from examples/bri-2/dashboard/assets/img/github.svg rename to examples/deprecated/bri-2/dashboard/assets/img/github.svg diff --git a/examples/bri-2/dashboard/assets/img/google.svg b/examples/deprecated/bri-2/dashboard/assets/img/google.svg similarity index 100% rename from examples/bri-2/dashboard/assets/img/google.svg rename to examples/deprecated/bri-2/dashboard/assets/img/google.svg diff --git a/examples/bri-2/dashboard/assets/img/identity.svg b/examples/deprecated/bri-2/dashboard/assets/img/identity.svg similarity index 100% rename from examples/bri-2/dashboard/assets/img/identity.svg rename to examples/deprecated/bri-2/dashboard/assets/img/identity.svg diff --git a/examples/bri-2/dashboard/assets/img/img-1-1000x600.jpg b/examples/deprecated/bri-2/dashboard/assets/img/img-1-1000x600.jpg similarity index 100% rename from examples/bri-2/dashboard/assets/img/img-1-1000x600.jpg rename to examples/deprecated/bri-2/dashboard/assets/img/img-1-1000x600.jpg diff --git a/examples/bri-2/dashboard/assets/img/key.svg b/examples/deprecated/bri-2/dashboard/assets/img/key.svg similarity index 100% rename from examples/bri-2/dashboard/assets/img/key.svg rename to examples/deprecated/bri-2/dashboard/assets/img/key.svg diff --git a/examples/bri-2/dashboard/assets/img/landing.jpg b/examples/deprecated/bri-2/dashboard/assets/img/landing.jpg similarity index 100% rename from examples/bri-2/dashboard/assets/img/landing.jpg rename to examples/deprecated/bri-2/dashboard/assets/img/landing.jpg diff --git a/examples/bri-2/dashboard/assets/img/login.jpg b/examples/deprecated/bri-2/dashboard/assets/img/login.jpg similarity index 100% rename from examples/bri-2/dashboard/assets/img/login.jpg rename to examples/deprecated/bri-2/dashboard/assets/img/login.jpg diff --git a/examples/bri-2/dashboard/assets/img/logoff.svg b/examples/deprecated/bri-2/dashboard/assets/img/logoff.svg similarity index 100% rename from examples/bri-2/dashboard/assets/img/logoff.svg rename to examples/deprecated/bri-2/dashboard/assets/img/logoff.svg diff --git a/examples/bri-2/dashboard/assets/img/no-workflows.png b/examples/deprecated/bri-2/dashboard/assets/img/no-workflows.png similarity index 100% rename from examples/bri-2/dashboard/assets/img/no-workflows.png rename to examples/deprecated/bri-2/dashboard/assets/img/no-workflows.png diff --git a/examples/bri-2/dashboard/assets/img/pattern_nextjs.png b/examples/deprecated/bri-2/dashboard/assets/img/pattern_nextjs.png similarity index 100% rename from examples/bri-2/dashboard/assets/img/pattern_nextjs.png rename to examples/deprecated/bri-2/dashboard/assets/img/pattern_nextjs.png diff --git a/examples/bri-2/dashboard/assets/img/profile.jpg b/examples/deprecated/bri-2/dashboard/assets/img/profile.jpg similarity index 100% rename from examples/bri-2/dashboard/assets/img/profile.jpg rename to examples/deprecated/bri-2/dashboard/assets/img/profile.jpg diff --git a/examples/bri-2/dashboard/assets/img/react.jpg b/examples/deprecated/bri-2/dashboard/assets/img/react.jpg similarity index 100% rename from examples/bri-2/dashboard/assets/img/react.jpg rename to examples/deprecated/bri-2/dashboard/assets/img/react.jpg diff --git a/examples/bri-2/dashboard/assets/img/register_bg_2.png b/examples/deprecated/bri-2/dashboard/assets/img/register_bg_2.png similarity index 100% rename from examples/bri-2/dashboard/assets/img/register_bg_2.png rename to examples/deprecated/bri-2/dashboard/assets/img/register_bg_2.png diff --git a/examples/bri-2/dashboard/assets/img/shield.svg b/examples/deprecated/bri-2/dashboard/assets/img/shield.svg similarity index 100% rename from examples/bri-2/dashboard/assets/img/shield.svg rename to examples/deprecated/bri-2/dashboard/assets/img/shield.svg diff --git a/examples/bri-2/dashboard/assets/img/sketch.jpg b/examples/deprecated/bri-2/dashboard/assets/img/sketch.jpg similarity index 100% rename from examples/bri-2/dashboard/assets/img/sketch.jpg rename to examples/deprecated/bri-2/dashboard/assets/img/sketch.jpg diff --git a/examples/bri-2/dashboard/assets/img/team-1-800x800.jpg b/examples/deprecated/bri-2/dashboard/assets/img/team-1-800x800.jpg similarity index 100% rename from examples/bri-2/dashboard/assets/img/team-1-800x800.jpg rename to examples/deprecated/bri-2/dashboard/assets/img/team-1-800x800.jpg diff --git a/examples/bri-2/dashboard/assets/img/team-2-800x800.jpg b/examples/deprecated/bri-2/dashboard/assets/img/team-2-800x800.jpg similarity index 100% rename from examples/bri-2/dashboard/assets/img/team-2-800x800.jpg rename to examples/deprecated/bri-2/dashboard/assets/img/team-2-800x800.jpg diff --git a/examples/bri-2/dashboard/assets/img/team-3-800x800.jpg b/examples/deprecated/bri-2/dashboard/assets/img/team-3-800x800.jpg similarity index 100% rename from examples/bri-2/dashboard/assets/img/team-3-800x800.jpg rename to examples/deprecated/bri-2/dashboard/assets/img/team-3-800x800.jpg diff --git a/examples/bri-2/dashboard/assets/img/team-4-470x470.png b/examples/deprecated/bri-2/dashboard/assets/img/team-4-470x470.png similarity index 100% rename from examples/bri-2/dashboard/assets/img/team-4-470x470.png rename to examples/deprecated/bri-2/dashboard/assets/img/team-4-470x470.png diff --git a/examples/bri-2/dashboard/assets/img/vue.jpg b/examples/deprecated/bri-2/dashboard/assets/img/vue.jpg similarity index 100% rename from examples/bri-2/dashboard/assets/img/vue.jpg rename to examples/deprecated/bri-2/dashboard/assets/img/vue.jpg diff --git a/examples/bri-2/dashboard/assets/styles/index.css b/examples/deprecated/bri-2/dashboard/assets/styles/index.css similarity index 100% rename from examples/bri-2/dashboard/assets/styles/index.css rename to examples/deprecated/bri-2/dashboard/assets/styles/index.css diff --git a/examples/bri-2/dashboard/assets/styles/tailwind.css b/examples/deprecated/bri-2/dashboard/assets/styles/tailwind.css similarity index 100% rename from examples/bri-2/dashboard/assets/styles/tailwind.css rename to examples/deprecated/bri-2/dashboard/assets/styles/tailwind.css diff --git a/examples/bri-2/dashboard/assets/styles/tree-basic.css b/examples/deprecated/bri-2/dashboard/assets/styles/tree-basic.css similarity index 100% rename from examples/bri-2/dashboard/assets/styles/tree-basic.css rename to examples/deprecated/bri-2/dashboard/assets/styles/tree-basic.css diff --git a/examples/bri-2/dashboard/assets/styles/tree.css b/examples/deprecated/bri-2/dashboard/assets/styles/tree.css similarity index 100% rename from examples/bri-2/dashboard/assets/styles/tree.css rename to examples/deprecated/bri-2/dashboard/assets/styles/tree.css diff --git a/examples/bri-2/dashboard/components/Cards/CardCommit.js b/examples/deprecated/bri-2/dashboard/components/Cards/CardCommit.js similarity index 100% rename from examples/bri-2/dashboard/components/Cards/CardCommit.js rename to examples/deprecated/bri-2/dashboard/components/Cards/CardCommit.js diff --git a/examples/bri-2/dashboard/components/Cards/CardContracts.js b/examples/deprecated/bri-2/dashboard/components/Cards/CardContracts.js similarity index 100% rename from examples/bri-2/dashboard/components/Cards/CardContracts.js rename to examples/deprecated/bri-2/dashboard/components/Cards/CardContracts.js diff --git a/examples/bri-2/dashboard/components/Cards/CardDidCreateIdentity.js b/examples/deprecated/bri-2/dashboard/components/Cards/CardDidCreateIdentity.js similarity index 100% rename from examples/bri-2/dashboard/components/Cards/CardDidCreateIdentity.js rename to examples/deprecated/bri-2/dashboard/components/Cards/CardDidCreateIdentity.js diff --git a/examples/bri-2/dashboard/components/Cards/CardDidGenerator.js b/examples/deprecated/bri-2/dashboard/components/Cards/CardDidGenerator.js similarity index 100% rename from examples/bri-2/dashboard/components/Cards/CardDidGenerator.js rename to examples/deprecated/bri-2/dashboard/components/Cards/CardDidGenerator.js diff --git a/examples/bri-2/dashboard/components/Cards/CardDidVerifyIdentity.js b/examples/deprecated/bri-2/dashboard/components/Cards/CardDidVerifyIdentity.js similarity index 100% rename from examples/bri-2/dashboard/components/Cards/CardDidVerifyIdentity.js rename to examples/deprecated/bri-2/dashboard/components/Cards/CardDidVerifyIdentity.js diff --git a/examples/bri-2/dashboard/components/Cards/CardPhonebook.js b/examples/deprecated/bri-2/dashboard/components/Cards/CardPhonebook.js similarity index 100% rename from examples/bri-2/dashboard/components/Cards/CardPhonebook.js rename to examples/deprecated/bri-2/dashboard/components/Cards/CardPhonebook.js diff --git a/examples/bri-2/dashboard/components/Cards/CardStats.js b/examples/deprecated/bri-2/dashboard/components/Cards/CardStats.js similarity index 100% rename from examples/bri-2/dashboard/components/Cards/CardStats.js rename to examples/deprecated/bri-2/dashboard/components/Cards/CardStats.js diff --git a/examples/bri-2/dashboard/components/Cards/CardTree.js b/examples/deprecated/bri-2/dashboard/components/Cards/CardTree.js similarity index 100% rename from examples/bri-2/dashboard/components/Cards/CardTree.js rename to examples/deprecated/bri-2/dashboard/components/Cards/CardTree.js diff --git a/examples/bri-2/dashboard/components/Cards/CardWorkflow.js b/examples/deprecated/bri-2/dashboard/components/Cards/CardWorkflow.js similarity index 100% rename from examples/bri-2/dashboard/components/Cards/CardWorkflow.js rename to examples/deprecated/bri-2/dashboard/components/Cards/CardWorkflow.js diff --git a/examples/bri-2/dashboard/components/Cards/CardWorkflowTest.js b/examples/deprecated/bri-2/dashboard/components/Cards/CardWorkflowTest.js similarity index 100% rename from examples/bri-2/dashboard/components/Cards/CardWorkflowTest.js rename to examples/deprecated/bri-2/dashboard/components/Cards/CardWorkflowTest.js diff --git a/examples/bri-2/dashboard/components/Cards/CardWorkflows.js b/examples/deprecated/bri-2/dashboard/components/Cards/CardWorkflows.js similarity index 100% rename from examples/bri-2/dashboard/components/Cards/CardWorkflows.js rename to examples/deprecated/bri-2/dashboard/components/Cards/CardWorkflows.js diff --git a/examples/bri-2/dashboard/components/Dropdowns/CommitDropdown.js b/examples/deprecated/bri-2/dashboard/components/Dropdowns/CommitDropdown.js similarity index 100% rename from examples/bri-2/dashboard/components/Dropdowns/CommitDropdown.js rename to examples/deprecated/bri-2/dashboard/components/Dropdowns/CommitDropdown.js diff --git a/examples/bri-2/dashboard/components/Dropdowns/NotificationDropdown.js b/examples/deprecated/bri-2/dashboard/components/Dropdowns/NotificationDropdown.js similarity index 100% rename from examples/bri-2/dashboard/components/Dropdowns/NotificationDropdown.js rename to examples/deprecated/bri-2/dashboard/components/Dropdowns/NotificationDropdown.js diff --git a/examples/bri-2/dashboard/components/Dropdowns/PhonebookDropdown.js b/examples/deprecated/bri-2/dashboard/components/Dropdowns/PhonebookDropdown.js similarity index 100% rename from examples/bri-2/dashboard/components/Dropdowns/PhonebookDropdown.js rename to examples/deprecated/bri-2/dashboard/components/Dropdowns/PhonebookDropdown.js diff --git a/examples/bri-2/dashboard/components/Dropdowns/UserDropdown.js b/examples/deprecated/bri-2/dashboard/components/Dropdowns/UserDropdown.js similarity index 100% rename from examples/bri-2/dashboard/components/Dropdowns/UserDropdown.js rename to examples/deprecated/bri-2/dashboard/components/Dropdowns/UserDropdown.js diff --git a/examples/bri-2/dashboard/components/Dropdowns/WorkflowDropdown.js b/examples/deprecated/bri-2/dashboard/components/Dropdowns/WorkflowDropdown.js similarity index 100% rename from examples/bri-2/dashboard/components/Dropdowns/WorkflowDropdown.js rename to examples/deprecated/bri-2/dashboard/components/Dropdowns/WorkflowDropdown.js diff --git a/examples/bri-2/dashboard/components/Footers/FooterAdmin.js b/examples/deprecated/bri-2/dashboard/components/Footers/FooterAdmin.js similarity index 92% rename from examples/bri-2/dashboard/components/Footers/FooterAdmin.js rename to examples/deprecated/bri-2/dashboard/components/Footers/FooterAdmin.js index d37a300be..e77c4f293 100644 --- a/examples/bri-2/dashboard/components/Footers/FooterAdmin.js +++ b/examples/deprecated/bri-2/dashboard/components/Footers/FooterAdmin.js @@ -29,7 +29,7 @@ export default function FooterAdmin() {