From a94fee5f68216519162c20db090b5a86b58c0c4a Mon Sep 17 00:00:00 2001 From: Stephen Curran Date: Wed, 24 Dec 2025 08:01:05 -0800 Subject: [PATCH] Update after move to new GitHub org Signed-off-by: Stephen Curran --- .devcontainer/Dockerfile | 2 +- .github/workflows/PR.yaml | 8 +- .github/workflows/Push.yaml | 10 +- .github/workflows/README.md | 2 +- .../workflows/build/Dockerfile.ubuntu-2004 | 2 +- .github/workflows/publishRelease.yaml | 8 +- .github/workflows/releasepr.yaml | 12 +- .github/workflows/tag.yaml | 4 +- .gitpod.Dockerfile | 2 +- CHANGELOG.md | 12 +- CODEOWNERS | 4 +- MAINTAINERS.md | 2 +- README.md | 56 +++--- SECURITY.md | 185 ++++++++++++++++-- build-scripts/ubuntu-2004/Dockerfile | 2 +- design/anoncreds.md | 2 +- docs/source/1.3_to_1.4_migration_guide.md | 10 +- docs/source/ci-cd.md | 14 +- docs/source/conf.py | 2 +- .../install-docs/AWS-NodeInstall-20.04.md | 4 +- .../install-docs/Azure-NodeInstall-20.04.md | 4 +- .../install-docs/GC-NodeInstall-20.04.md | 4 +- .../Physical-NodeInstall-20.04.md | 4 +- .../install-docs/validator-prep-20.04.md | 6 +- docs/source/node-add-troubleshooting.md | 2 +- .../node-monitoring-tools-for-stewards.md | 2 +- docs/source/requests-new.md | 10 +- docs/source/requests.md | 8 +- docs/source/setup-iptables.md | 6 +- docs/source/start-nodes.md | 4 +- docs/source/transactions.md | 2 +- docs/source/troubleshooting.md | 16 +- environment/docker/baseimage/Makefile | 2 +- environment/docker/baseimage/README.md | 8 +- .../docker/pool/client.ubuntu.dockerfile | 2 +- environment/openshift/README.md | 2 +- environment/openshift/oc_configure_builds.sh | 2 +- .../openshift/templates/buildConfig.json | 2 +- .../AWS/scriptlets/common/pre/linux/yum/setup | 2 +- .../AWS/scriptlets/indy-sdk/linux/pre/setup | 2 +- .../Virtualbox/Vagrantfile | 2 +- .../vb-multi-vm/TestIndyClusterSetup.md | 6 +- indy_node/__metadata__.py | 2 +- indy_node/test/rich_schema/templates.py | 6 +- .../roles/perf_scripts/tasks/main.yml | 2 +- scripts/performance/perf_load/__version__.py | 2 +- .../performance/perf_load/perf_processes.py | 2 +- setup.py | 2 +- 48 files changed, 303 insertions(+), 154 deletions(-) diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile index b7c9e5f04..872ddbadf 100644 --- a/.devcontainer/Dockerfile +++ b/.devcontainer/Dockerfile @@ -25,7 +25,7 @@ RUN apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 9692C00E657DDE61 && # ======================================================================================================== # Plenum -# - https://github.com/hyperledger/indy-plenum/issues/1546 +# - https://github.com/hyperledger-indy/indy-plenum/issues/1546 # - Needed to pick up rocksdb=5.8.8 RUN echo "deb https://hyperledger.jfrog.io/artifactory/indy focal dev" >> /etc/apt/sources.list && \ echo "deb http://security.ubuntu.com/ubuntu bionic-security main" >> /etc/apt/sources.list && \ diff --git a/.github/workflows/PR.yaml b/.github/workflows/PR.yaml index e3a2f617c..00c6923b3 100644 --- a/.github/workflows/PR.yaml +++ b/.github/workflows/PR.yaml @@ -30,7 +30,7 @@ jobs: uses: actions/checkout@v4 - name: setup id: setup - uses: hyperledger/indy-shared-gha/.github/actions/workflow-setup@v1 + uses: hyperledger-indy/indy-shared-gha/.github/actions/workflow-setup@v1 - name: testsNeeded id: testsNeeded uses: dorny/paths-filter@v3 @@ -46,12 +46,12 @@ jobs: name: Lint needs: [workflow-setup] if: ${{ needs.workflow-setup.outputs.testsNeeded == 'true' }} - uses: hyperledger/indy-shared-gha/.github/workflows/lint.yaml@v1 + uses: hyperledger-indy/indy-shared-gha/.github/workflows/lint.yaml@v1 build-image: name: Create Builder Image needs: [workflow-setup, lint] - uses: hyperledger/indy-shared-gha/.github/workflows/buildimage.yaml@v1 + uses: hyperledger-indy/indy-shared-gha/.github/workflows/buildimage.yaml@v1 with: CACHE_KEY_BUILD: ${{ needs.workflow-setup.outputs.CACHE_KEY_BUILD }} DOCKER_IMAGE: ghcr.io/${{ needs.workflow-setup.outputs.GITHUB_REPOSITORY_NAME }}/node-build @@ -60,7 +60,7 @@ jobs: build_packages: name: Build Packages needs: [workflow-setup, build-image] - uses: hyperledger/indy-shared-gha/.github/workflows/buildpackages.yaml@v1 + uses: hyperledger-indy/indy-shared-gha/.github/workflows/buildpackages.yaml@v1 with: DOCKER_IMAGE: ghcr.io/${{ needs.workflow-setup.outputs.GITHUB_REPOSITORY_NAME }}/node-build:${{ needs.workflow-setup.outputs.UBUNTU_VERSION }} UBUNTU_VERSION: ${{ needs.workflow-setup.outputs.UBUNTU_VERSION }} diff --git a/.github/workflows/Push.yaml b/.github/workflows/Push.yaml index ba6d6c00d..942567e39 100644 --- a/.github/workflows/Push.yaml +++ b/.github/workflows/Push.yaml @@ -29,16 +29,16 @@ jobs: uses: actions/checkout@v4 - name: setup id: setup - uses: hyperledger/indy-shared-gha/.github/actions/workflow-setup@v1 + uses: hyperledger-indy/indy-shared-gha/.github/actions/workflow-setup@v1 lint: name: Lint - uses: hyperledger/indy-shared-gha/.github/workflows/lint.yaml@v1 + uses: hyperledger-indy/indy-shared-gha/.github/workflows/lint.yaml@v1 build-image: name: Create Builder Image needs: [workflow-setup, lint] - uses: hyperledger/indy-shared-gha/.github/workflows/buildimage.yaml@v1 + uses: hyperledger-indy/indy-shared-gha/.github/workflows/buildimage.yaml@v1 with: CACHE_KEY_BUILD: ${{ needs.workflow-setup.outputs.CACHE_KEY_BUILD }} DOCKER_IMAGE: ghcr.io/${{ needs.workflow-setup.outputs.GITHUB_REPOSITORY_NAME }}/node-build @@ -47,7 +47,7 @@ jobs: build_packages: name: Build Packages needs: [workflow-setup, build-image] - uses: hyperledger/indy-shared-gha/.github/workflows/buildpackages.yaml@v1 + uses: hyperledger-indy/indy-shared-gha/.github/workflows/buildpackages.yaml@v1 with: DOCKER_IMAGE: ghcr.io/${{ needs.workflow-setup.outputs.GITHUB_REPOSITORY_NAME }}/node-build:${{ needs.workflow-setup.outputs.UBUNTU_VERSION }} UBUNTU_VERSION: ${{ needs.workflow-setup.outputs.UBUNTU_VERSION }} @@ -67,7 +67,7 @@ jobs: name: Publish Artifacts needs: [workflow-setup, indy_node_tests] if: needs.workflow-setup.outputs.publish == 'true' - uses: hyperledger/indy-shared-gha/.github/workflows/publish_artifacts.yaml@v1 + uses: hyperledger-indy/indy-shared-gha/.github/workflows/publish_artifacts.yaml@v1 with: COMPONENT: 'dev' UBUNTU_VERSION: ${{ needs.workflow-setup.outputs.UBUNTU_VERSION }} diff --git a/.github/workflows/README.md b/.github/workflows/README.md index 790698ea2..8423705f1 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -5,7 +5,7 @@ which only contain changes to python files. If no python file is affected it doe The same applies to the [Push](Push.yaml) workflow respectively for pushes. The [tag](tag.yaml), [releasepr](releasepr.yaml) and [publishRelease](publishRelease.yaml) workflows are used for the new [Release Workflow](../../docs/release-workflow.png). -They use reuseable workflows from the [indy-shared-gha](https://github.com/hyperledger/indy-shared-gha) repository and the following workflow in this folder. +They use reuseable workflows from the [indy-shared-gha](https://github.com/hyperledger-indy/indy-shared-gha) repository and the following workflow in this folder. + [reuseable_test.yaml](reuseable_test.yaml) This workflow runs the tests inside the uploaded docker images. \ No newline at end of file diff --git a/.github/workflows/build/Dockerfile.ubuntu-2004 b/.github/workflows/build/Dockerfile.ubuntu-2004 index cf8a4583a..9208ea048 100644 --- a/.github/workflows/build/Dockerfile.ubuntu-2004 +++ b/.github/workflows/build/Dockerfile.ubuntu-2004 @@ -24,7 +24,7 @@ RUN apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 9692C00E657DDE61 && # ======================================================================================================== # Plenum -# - https://github.com/hyperledger/indy-plenum/issues/1546 +# - https://github.com/hyperledger-indy/indy-plenum/issues/1546 # - Needed to pick up rocksdb=5.8.8 RUN echo "deb https://hyperledger.jfrog.io/artifactory/indy focal dev rc stable" >> /etc/apt/sources.list && \ echo "deb http://security.ubuntu.com/ubuntu bionic-security main" >> /etc/apt/sources.list && \ diff --git a/.github/workflows/publishRelease.yaml b/.github/workflows/publishRelease.yaml index 5b671bf7b..9c9d96325 100644 --- a/.github/workflows/publishRelease.yaml +++ b/.github/workflows/publishRelease.yaml @@ -33,12 +33,12 @@ jobs: uses: actions/checkout@v4 - name: get-release-info id: get-release-info - uses: hyperledger/indy-shared-gha/.github/actions/get-release-info@v1 + uses: hyperledger-indy/indy-shared-gha/.github/actions/get-release-info@v1 with: versionString: "${{ github.event.head_commit.message }}" - name: workflow-setup id: workflow-setup - uses: hyperledger/indy-shared-gha/.github/actions/workflow-setup@v1 + uses: hyperledger-indy/indy-shared-gha/.github/actions/workflow-setup@v1 createRelease: name: Create Release @@ -110,7 +110,7 @@ jobs: name: Publish Artifacts needs: [release-infos, createRelease] if: needs.release-infos.outputs.isVersionBump == 'true' && needs.release-infos.outputs.publish == 'true' - uses: hyperledger/indy-shared-gha/.github/workflows/publish_artifacts.yaml@v1 + uses: hyperledger-indy/indy-shared-gha/.github/workflows/publish_artifacts.yaml@v1 with: COMPONENT: ${{ needs.release-infos.outputs.component }} UBUNTU_VERSION: ${{ needs.release-infos.outputs.UBUNTU_VERSION }} @@ -123,7 +123,7 @@ jobs: convertPyVersion: name: "Convert to python version flavour" needs: [release-infos, publish_artifacts] - uses: hyperledger/indy-shared-gha/.github/workflows/pyVersionConversion.yaml@v1 + uses: hyperledger-indy/indy-shared-gha/.github/workflows/pyVersionConversion.yaml@v1 with: VERSIONTAG: ${{ needs.release-infos.outputs.VERSIONTAG }} diff --git a/.github/workflows/releasepr.yaml b/.github/workflows/releasepr.yaml index 80fc1ece5..cef3155b8 100644 --- a/.github/workflows/releasepr.yaml +++ b/.github/workflows/releasepr.yaml @@ -26,24 +26,24 @@ jobs: uses: actions/checkout@v4 - name: get-release-info id: get-release-info - uses: hyperledger/indy-shared-gha/.github/actions/get-release-info@v1 + uses: hyperledger-indy/indy-shared-gha/.github/actions/get-release-info@v1 with: versionString: "${{ github.event.pull_request.body }}" - name: workflow-setup id: workflow-setup - uses: hyperledger/indy-shared-gha/.github/actions/workflow-setup@v1 + uses: hyperledger-indy/indy-shared-gha/.github/actions/workflow-setup@v1 lint: name: Lint needs: [release-infos] if: needs.release-infos.outputs.isVersionBump == 'true' - uses: hyperledger/indy-shared-gha/.github/workflows/lint.yaml@v1 + uses: hyperledger-indy/indy-shared-gha/.github/workflows/lint.yaml@v1 build-docker-image: name: Create Builder Image needs: [release-infos, lint] if: needs.release-infos.outputs.isVersionBump == 'true' - uses: hyperledger/indy-shared-gha/.github/workflows/buildimage.yaml@v1 + uses: hyperledger-indy/indy-shared-gha/.github/workflows/buildimage.yaml@v1 with: CACHE_KEY_BUILD: ${{ needs.release-infos.outputs.CACHE_KEY_BUILD }} DOCKER_IMAGE: ghcr.io/${{ needs.release-infos.outputs.GITHUB_REPOSITORY_NAME }}/node-build @@ -53,7 +53,7 @@ jobs: name: Build Packages needs: [release-infos, build-docker-image] if: needs.release-infos.outputs.isVersionBump == 'true' - uses: hyperledger/indy-shared-gha/.github/workflows/buildpackages.yaml@v1 + uses: hyperledger-indy/indy-shared-gha/.github/workflows/buildpackages.yaml@v1 with: DOCKER_IMAGE: ghcr.io/${{ needs.release-infos.outputs.GITHUB_REPOSITORY_NAME }}/node-build:${{ needs.release-infos.outputs.UBUNTU_VERSION }} UBUNTU_VERSION: ${{ needs.release-infos.outputs.UBUNTU_VERSION }} @@ -73,7 +73,7 @@ jobs: call-indy-test-automation: name: Indy-Test-Automation needs: [build_packages] - uses: hyperledger/indy-test-automation/.github/workflows/callable_test-automation-node.yaml@v0.11 + uses: hyperledger-indy/indy-test-automation/.github/workflows/callable_test-automation-node.yaml@v0.11 with: ubuntuVersion: "ubuntu-2004" libIndyVersion: "1.15.0~1625-bionic" diff --git a/.github/workflows/tag.yaml b/.github/workflows/tag.yaml index b30e3329e..e877416de 100644 --- a/.github/workflows/tag.yaml +++ b/.github/workflows/tag.yaml @@ -21,12 +21,12 @@ jobs: fetch-depth: 0 - name: extract branch id: get-branch - uses: hyperledger/indy-shared-gha/.github/actions/branch-from-tag@v1 + uses: hyperledger-indy/indy-shared-gha/.github/actions/branch-from-tag@v1 with: tag: ${{ github.ref }} - name: get-release-info id: get-release-info - uses: hyperledger/indy-shared-gha/.github/actions/get-release-info@v1 + uses: hyperledger-indy/indy-shared-gha/.github/actions/get-release-info@v1 with: versionString: "${{ github.ref }}" diff --git a/.gitpod.Dockerfile b/.gitpod.Dockerfile index 34b65dd5f..4b918ed9a 100644 --- a/.gitpod.Dockerfile +++ b/.gitpod.Dockerfile @@ -24,7 +24,7 @@ RUN sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 9692C00E657DDE # ======================================================================================================== # Plenum -# - https://github.com/hyperledger/indy-plenum/issues/1546 +# - https://github.com/hyperledger-indy/indy-plenum/issues/1546 # - Needed to pick up rocksdb=5.8.8 RUN sudo add-apt-repository 'deb https://hyperledger.jfrog.io/artifactory/indy focal dev' && \ sudo add-apt-repository 'deb http://security.ubuntu.com/ubuntu bionic-security main' && \ diff --git a/CHANGELOG.md b/CHANGELOG.md index b2a1a94cd..1f7075559 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -712,9 +712,9 @@ Summary: If there are NODE txns for adding/removing nodes interleaved with View ### Additional Information: -**Warning: Embedded command-line tool _indy_ is no longer available.** For further pool interaction use _indy-cli_ package https://github.com/hyperledger/indy-sdk/tree/master/cli +**Warning: Embedded command-line tool _indy_ is no longer available.** For further pool interaction use _indy-cli_ package https://github.com/hyperledger-indy/indy-sdk/tree/master/cli -[**indy-test-automation repo**](https://github.com/hyperledger/indy-test-automation) has been created for end-to-end tests and additional test tools [**(INDY-1766)**](https://jira.hyperledger.org/browse/INDY-1766) +[**indy-test-automation repo**](https://github.com/hyperledger-indy/indy-test-automation) has been created for end-to-end tests and additional test tools [**(INDY-1766)**](https://jira.hyperledger.org/browse/INDY-1766) **The** [**INDY-1818**](https://jira.hyperledger.org/browse/INDY-1818) **(Init Indy Node should output Base58-encrypted verkey already) affects nodes adding.** @@ -1087,7 +1087,7 @@ For more details about txn format changes see INDY-1421.** | Move the log compression into separate process. | | [INDY-1275](https://jira.hyperledger.org/browse/INDY-1275) | | **Known Issue:** There's an incorrect read\_ledger info with seq\_no parameter. | | [INDY-1415](https://jira.hyperledger.org/browse/INDY-1415) | | **Known Issue:** Pool upgrade should be performed simultaneously for all nodes due to txn format changes. All indy-cli pools should be recreated with actual genesis files. | | | -| **List of breaking changes for migration from indy-node 1.3 to 1.4:** | | [1.3-1.4 Migration Guide](https://github.com/hyperledger/indy-node/blob/master/docs/1.3_to_1.4_migration_guide.md) | +| **List of breaking changes for migration from indy-node 1.3 to 1.4:** | | [1.3-1.4 Migration Guide](https://github.com/hyperledger-indy/indy-node/blob/master/docs/1.3_to_1.4_migration_guide.md) | ### Upgrade Scripts: @@ -1112,7 +1112,7 @@ recreate indy-cli pool using 1.4 pool genesis file (from 1.4 node) **List of breaking changes for migration from indy-node 1.3 to 1.4:** -https://github.com/hyperledger/indy-node/blob/master/docs/1.3\_to\_1.4\_migration\_guide.md +https://github.com/hyperledger-indy/indy-node/blob/master/docs/1.3\_to\_1.4\_migration\_guide.md **IndyNode 1.4 and LibIndy 1.5 compatibility:** @@ -1130,7 +1130,7 @@ If an app wants to work with the latest master or Stable Node 1.4, then they nee call `indy_set_protocol_version(2)` during app initialization -Use https://github.com/hyperledger/indy-sdk/blob/b4a2bb82087e2eafe5e55bddb20a3069e5fb7d0b/cli/README.md#old-python-based-cli-migration to export dids from your old CLI wallet to the new one (new indy-cli). +Use https://github.com/hyperledger-indy/indy-sdk/blob/b4a2bb82087e2eafe5e55bddb20a3069e5fb7d0b/cli/README.md#old-python-based-cli-migration to export dids from your old CLI wallet to the new one (new indy-cli). @@ -1160,7 +1160,7 @@ Use https://github.com/hyperledger/indy-sdk/blob/b4a2bb82087e2eafe5e55bddb20a306 | Description | Workaround | Ticket | | --- | --- | --- | -| Support was added for supervisord. | | [https://github.com/hyperledger/indy-node/pull/588](https://jira.hyperledger.org/browse/INDY-1186) | +| Support was added for supervisord. | | [https://github.com/hyperledger-indy/indy-node/pull/588](https://jira.hyperledger.org/browse/INDY-1186) | | Indy-node dependencies are fixed. | | | | | | | | diff --git a/CODEOWNERS b/CODEOWNERS index 0f08cb393..794a8c8d3 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -1,7 +1,7 @@ # SPDX-License-Identifier: Apache-2.0 # Indy Admin -* @hyperledger/indy-admin +* @hyperledger-indy/indy-admin # Indy Common -* @hyperledger/indy-common +* @hyperledger-indy/indy-common diff --git a/MAINTAINERS.md b/MAINTAINERS.md index 995c6eff6..e5d0d0124 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -3,7 +3,7 @@ ## Maintainer Scopes, GitHub Roles and GitHub Teams The Maintainers of this repo, defined as GitHub users with escalated privileges -in the repo, are managed in the Hyperledger "governance" repo's [access control file](https://github.com/hyperledger/governance/blob/main/access-control.yaml). Consult that to see: +in the repo, are managed in the Hyperledger "governance" repo's [access control file](https://github.com/hyperledger-indy/governance/blob/main/config.yaml). Consult that to see: - What teams have escalated privileges to this repository. - What GitHub roles those teams have in the repository. diff --git a/README.md b/README.md index f9fb0dc61..c8b001366 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ ![logo](collateral/logos/indy-logo.png) -[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/hyperledger/indy-node/tree/main) +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/hyperledger-indy/indy-node/tree/main)

- +

# Indy Node @@ -46,7 +46,7 @@ The following changes were made to the branches: This codebase embodies all the functionality to run nodes (validators and/or observers) that provide a [self-sovereign identity ecosystem](https://sovrin.org) on top of a distributed ledger. It is the core project for Indy; over time, all other indy-\* projects may -collapse into this one, except for [indy-sdk](https://github.com/hyperledger/indy-sdk). +collapse into this one, except for [indy-sdk](https://github.com/hyperledger-indy/indy-sdk). Indy has its own distributed ledger based on RBFT. @@ -60,9 +60,9 @@ with a different network, using whatever conventions a community chooses. ##### Getting Started Guide We recommend that developers should explore -[Indy Walk through](https://github.com/hyperledger/indy-sdk/blob/master/docs/getting-started/indy-walkthrough.md) to learn about Indy basics -or [Getting Started Guide with VCX](https://github.com/hyperledger/indy-sdk/blob/master/vcx/docs/getting-started/getting-started.md) and -[Getting Started Notebook](https://github.com/hyperledger/indy-sdk/blob/master/docs/getting-started/getting-started.ipynb). +[Indy Walk through](https://github.com/hyperledger-indy/indy-sdk/blob/master/docs/getting-started/indy-walkthrough.md) to learn about Indy basics +or [Getting Started Guide with VCX](https://github.com/hyperledger-indy/indy-sdk/blob/master/vcx/docs/getting-started/getting-started.md) and +[Getting Started Notebook](https://github.com/hyperledger-indy/indy-sdk/blob/master/docs/getting-started/getting-started.ipynb). ##### Hyperledger Wiki-Indy @@ -73,15 +73,15 @@ If you haven't done so already, please visit the main resource for all things "I - Refer to our documentation site at `indy.readthedocs.io` for the most current documentation and walkthroughs - [indy.readthedocs.io/projects/plenum](https://hyperledger-indy.readthedocs.io/projects/plenum/en/latest/index.html) - [indy.readthedocs.io/projects/node](https://hyperledger-indy.readthedocs.io/projects/node/en/latest/index.html) -- Please visit [Technical Overview of Plenum](https://github.com/hyperledger/indy-plenum/blob/master/docs/source/main.md). -- More documentation can be found in [indy-plenum-docs](https://github.com/hyperledger/indy-plenum/blob/master/docs) -and [indy-node-docs](https://github.com/hyperledger/indy-node/blob/master/docs/source). +- Please visit [Technical Overview of Plenum](https://github.com/hyperledger-indy/indy-plenum/blob/master/docs/source/main.md). +- More documentation can be found in [indy-plenum-docs](https://github.com/hyperledger-indy/indy-plenum/blob/master/docs) +and [indy-node-docs](https://github.com/hyperledger-indy/indy-node/blob/master/docs/source). ## Indy Node Repository Structure Indy Node repo consists of the following parts: - indy-node: - - [indy-plenum](https://github.com/hyperledger/indy-plenum)-based implementation of distributed ledger + - [indy-plenum](https://github.com/hyperledger-indy/indy-plenum)-based implementation of distributed ledger - Extends plenum's base pool functionality with specific transactions support (CLAIM_DEF, SCHEMA, POOL_UPGRADE, etc.) - indy-common - Common code for indy-node @@ -95,13 +95,13 @@ Indy Node repo consists of the following parts: ## Dependent Projects -- [indy-plenum](https://github.com/hyperledger/indy-plenum) +- [indy-plenum](https://github.com/hyperledger-indy/indy-plenum) - The heart of the distributed ledger technology inside Hyperledger Indy. - Most probably you will need to make changes in Plenum if you want to contribute to Indy. So, if you want to work with Indy Node, you will need to have the Plenum code as well in most of the cases and work with two projects at the same time (see [How to Start Working with the Code](#how-to-start-working-with-the-code) below). -- [indy-sdk](https://github.com/hyperledger/indy-sdk) +- [indy-sdk](https://github.com/hyperledger-indy/indy-sdk) - An official SDK for Indy. - It contains client and anoncreds implementation - You don't need it to contribute to Indy-Node. But please use indy-sdk for your own applications dealing with Indy ecosystem. @@ -139,8 +139,8 @@ The described process is automated in one of the ways below (it allow to install - **Docker** [Start Pool with Docker](environment/docker/pool/README.md) - **Docker-based pool using with new libindy-based CLI**: - - [Start Pool Locally](https://github.com/hyperledger/indy-sdk/blob/master/README.md#how-to-start-local-nodes-pool-with-docker) - - [Get Started with Libindy](https://github.com/hyperledger/indy-sdk/blob/master/doc/getting-started/getting-started.md) + - [Start Pool Locally](https://github.com/hyperledger-indy/indy-sdk/blob/master/README.md#how-to-start-local-nodes-pool-with-docker) + - [Get Started with Libindy](https://github.com/hyperledger-indy/indy-sdk/blob/master/doc/getting-started/getting-started.md) - **Also coming soon:** Create virtual machines in AWS. @@ -154,8 +154,8 @@ If you are new to the concept of devcontainers in combination with VSCode [here] Simply clone this repository and VSCode will most likely ask you to open it in the devcontainer, if you have the correct extension("ms-vscode-remote.remote-containers") installed. If VSCode didn't ask to open it, open the command palette and use the `Remote-Containers: Rebuild and Reopen in Container` command. -If you want to use Gitpod simply use this [link](https://gitpod.io/#https://github.com/hyperledger/indy-node/tree/main) -or if you want to work with your fork, prefix the entire URL of your branch with `gitpod.io/#` so that it looks like `https://gitpod.io/#https://github.com/hyperledger/indy-node/tree/main`. +If you want to use Gitpod simply use this [link](https://gitpod.io/#https://github.com/hyperledger-indy/indy-node/tree/main) +or if you want to work with your fork, prefix the entire URL of your branch with `gitpod.io/#` so that it looks like `https://gitpod.io/#https://github.com/hyperledger-indy/indy-node/tree/main`. **Note**: Be aware that the config files for Gitpod and VSCode are currently only used in the `main` branch! @@ -189,7 +189,7 @@ If you made changes in both indy-plenum and indy-node, you need to do the follow - Raise a PR to indy-plenum's master and wait until code is reviewed and merged (see above) - So, a new build of indy-plenum is created - Note a just built version `X.Y.Z.devB` of indy-plenum (you can check it in [pypi](https://pypi.python.org/pypi/indy-plenum) or on CI server). -- Change indy-plenum's dependency version to the new one in indy-node's [setup.py](https://github.com/hyperledger/indy-node/blob/master/setup.py). +- Change indy-plenum's dependency version to the new one in indy-node's [setup.py](https://github.com/hyperledger-indy/indy-node/blob/master/setup.py). - Raise PR to indy-node's master and wait until code is reviewed and merged (see above) - So, a new build of indy-node is created @@ -198,20 +198,20 @@ If you made changes in both indy-plenum and indy-node, you need to do the follow - Indy-plenum is based on [RBFT](https://pakupaku.me/plaublin/rbft/5000a297.pdf) protocol - Please have a look at documents and diagrams in [docs/source](docs/source) folder -- Please have a look at documents and diagrams in Plenum's [docs](https://github.com/hyperledger/indy-plenum/tree/master/docs) folder, or on https://indy.readthedocs.io/projects/plenum : - - [Technical Overview of Plenum](https://github.com/hyperledger/indy-plenum/blob/master/docs/source/main.md) - - [Plenum Consensus Algorithm Diagram](https://github.com/hyperledger/indy-plenum/blob/master/docs/source/diagrams/consensus-protocol.png) - - [Glossary](https://github.com/hyperledger/indy-plenum/blob/master/docs/source/glossary.md) - - [Storages](https://github.com/hyperledger/indy-plenum/blob/master/docs/source/storage.md) - - [Request Handling](https://github.com/hyperledger/indy-plenum/blob/master/docs/source/request_handling.md) - - [Catchup](https://github.com/hyperledger/indy-plenum/blob/master/docs/source/catchup.md) - - [Catchup Diagram](https://github.com/hyperledger/indy-plenum/blob/master/docs/source/diagrams/catchup-procedure.png) - - [Audit Ledger](https://github.com/hyperledger/indy-plenum/blob/master/docs/source/audit_ledger.md) - - [Plugins](https://github.com/hyperledger/indy-plenum/blob/master/docs/source/plugins.md) +- Please have a look at documents and diagrams in Plenum's [docs](https://github.com/hyperledger-indy/indy-plenum/tree/master/docs) folder, or on https://indy.readthedocs.io/projects/plenum : + - [Technical Overview of Plenum](https://github.com/hyperledger-indy/indy-plenum/blob/master/docs/source/main.md) + - [Plenum Consensus Algorithm Diagram](https://github.com/hyperledger-indy/indy-plenum/blob/master/docs/source/diagrams/consensus-protocol.png) + - [Glossary](https://github.com/hyperledger-indy/indy-plenum/blob/master/docs/source/glossary.md) + - [Storages](https://github.com/hyperledger-indy/indy-plenum/blob/master/docs/source/storage.md) + - [Request Handling](https://github.com/hyperledger-indy/indy-plenum/blob/master/docs/source/request_handling.md) + - [Catchup](https://github.com/hyperledger-indy/indy-plenum/blob/master/docs/source/catchup.md) + - [Catchup Diagram](https://github.com/hyperledger-indy/indy-plenum/blob/master/docs/source/diagrams/catchup-procedure.png) + - [Audit Ledger](https://github.com/hyperledger-indy/indy-plenum/blob/master/docs/source/audit_ledger.md) + - [Plugins](https://github.com/hyperledger-indy/indy-plenum/blob/master/docs/source/plugins.md) - Relationship between Entities and Transactions: [relationship diagram](docs/source/relationship-diagram.png) - Supported transactions and their format: [transactions](docs/source/transactions.md) - Supported requests (write, read) and their format: [requests](docs/source/requests.md) -- [Network roles and permissions](https://github.com/hyperledger/indy-node/blob/master/docs/source/auth_rules.md) +- [Network roles and permissions](https://github.com/hyperledger-indy/indy-node/blob/master/docs/source/auth_rules.md) - [Indy file folder structure guideline](docs/source/indy-file-structure-guideline.md) - [Helper Scripts](docs/source/helper-scripts.md) - [Pool Upgrade](docs/source/pool-upgrade.md) diff --git a/SECURITY.md b/SECURITY.md index 2f4eba8ac..9d4b6e1ff 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -1,23 +1,172 @@ -# Hyperledger Security Policy +# Hyperledger Indy Security Policy -## Reporting a Security Bug +[Hyperledger security vulnerability disclosure policy]: /governing-documents/security.md -If you think you have discovered a security issue in any of the Hyperledger -projects, we'd love to hear from you. We will take all security bugs -seriously and if confirmed upon investigation we will patch it within a -reasonable amount of time and release a public security bulletin discussing -the impact and credit the discoverer. +## About this document -There are two ways to report a security bug. The easiest is to email a -description of the flaw and any related information (e.g. reproduction -steps, version) to -[security at hyperledger dot org](mailto:security@hyperledger.org). +This document defines how security vulnerability reporting is handled in the +Hyperledger Indy project. The approach aligns with the [Hyperledger +Foundation's Security Vulnerability Reporting +policy](https://toc.hyperledger.org/governing-documents/security.html). Please +review that document to understand the basis of the security reporting for +Hyperledger Indy. -The other way is to file a confidential security bug in our -[JIRA bug tracking system](https://jira.hyperledger.org). -Be sure to set the “Security Level” to “Security issue”. +The Hyperledger Security Vulnerability policy borrows heavily from the +recommendations of the OpenSSF Vulnerability Disclosure working group. For +up-to-date information on the latest recommendations related to vulnerability +disclosures, please visit the [GitHub of that working +group](https://github.com/ossf/wg-vulnerability-disclosures). -The process by which the Hyperledger Security Team handles security bugs -is documented further in our -[Defect Response](https://wiki.hyperledger.org/display/HYP/Defect+Response) -page on our [wiki](https://wiki.hyperledger.org). +If you are already familiar with the security policies of Hyperledger Indy, and +ready to report a vulnerability, please jump to [Report +Intakes](#report-intakes). + +## Outline + +This document has the following sections: + +- [Hyperledger Indy Security Policy](#hyperledger-indy-security-policy) + - [About this document](#about-this-document) + - [Outline](#outline) + - [What Is a Vulnerability Disclosure Policy?](#what-is-a-vulnerability-disclosure-policy) + - [Security Team](#security-team) + - [Discussion Forums](#discussion-forums) + - [Report Intakes](#report-intakes) + - [CNA/CVE Reporting](#cnacve-reporting) + - [Embargo List](#embargo-list) + - [(GitHub) Security Advisories](#github-security-advisories) + - [Private Patch Deployment Infrastructure](#private-patch-deployment-infrastructure) + +## What Is a Vulnerability Disclosure Policy? + +No piece of software is perfect. All software (at least, all software of a +certain size and complexity) has bugs. In open source development, members of +the community or the public find bugs and report them to the project. A +vulnerability disclosure policy explains how this process functions from the +perspective of the project. + +This vulnerability disclosure policy explains the rules and guidelines for +Hyperledger Indy. It is intended to act as both a reference for +outsiders–including both bug reporters and those looking for information on the +project's security practices–as well as a set of rules that maintainers and +contributors have agreed to follow. + +## Security Team + +The current Hyperledger Indy security team is: + +| Name | Email ID | Discord ID | Area/Specialty | +| -------------- | --------------------------------- | ------------- | -------------------- | +| Stephen Curran | swcurran@cloudcompass.ca | swcurran | | +| Wade Barnes | wade@neoterictech.ca | WadeBarnes | Security, Operations | +| Sam Curren | sam@indicio.tech | TelegramSam | Security | +| Renata Toktar | renata.toktar@dsr-corporation.com | Renata.toktar | Security | + +The security team for Hyperledger Indy must include at least three Indy +Maintainers that agree to carry out the following duties and responsibilities. +Members are added and removed from the team via approved Pull Requests to this +repository. For additional background into the role of the security team, see +the [People Infrastructure] section of the Hyperledger Security Policy. + +[People Infrastructure]: https://toc.hyperledger.org/governing-documents/security.html#people-infrastructure + +**Responsibilities:** + +1. Acknowledge the receipt of vulnerability reports to the reporter within 2 + business days. + +2. Assess the issue. Engage with the reporter to ask any outstanding questions +about the report and how to reproduce it. If the report was received by email +and may be a security vulnerability, open a GitHub Security Advisory on the +repository to manage the report. If the report is not considered a +vulnerability, then the reporter should be informed and this process can be +halted. If the report is a regular bug (but not a security vulnerability), the +reporter should be informed (if necessary) of the regular process for reporting +issues. + +1. Some issues may require more time and resources to correct. If a particular +report is complex, discuss an embargo period with the reporter during which +time the report will not be publicly disclosed. The embargo period should be +negotiated with the reporter and must not be longer than 90 days. + +1. If necessary, create a private patch development infrastructure for the issue + by emailing the [Hyperledger Community Architects]. + +[Hyperledger Community Architects]: mailto:community-architects@hyperledger.org + +5. Request a CVE for the issue (see the [CNA/CVE Reporting](#cnacve-reporting) + section). + +6. Decide a date for the public release of the vulnerability report, the date + the embargo period ends. + +7. If applicable, notify members of the embargo list of the vulnerability, +upcoming patch and release, as described above. + +8. Publish a new (software) release in which the vulnerability is addressed. + +9. Publicly disclose the issue within 48 hours after the release via a +GitHub security advisory (see the [(GitHub) Security +Advisories](#github-security-advisories) section for details). + +## Discussion Forums + +Discussions about each reported vulnerability should be carried out in the +private GitHub security advisory about the vulnerability. If necessary, a private +channel specific to the issue may be created on the Hyperledger Discord server +with invited participants added to the discussion. + +## Report Intakes + +Hyperledger Indy has the following ways to submit security +vulnerabilities. While the security team members will do their best to +respond to bugs disclosed in all possible ways, it is encouraged for bug +finders to report through the following approved channels: + +- Email the [Hyperledger Foundation security +list](mailto:security@lists.hyperledger.org): To report a security issue, please +send an email with the name of the project/repository, a description of the issue, the +steps you took to create the issue, affected versions, and if known, +mitigations. If in triaging the email, the security team determines the issue may be +a security vulnerability, a [GitHub security vulnerability report] will be +opened. +- Open a [GitHub security vulnerability report]: Open a draft security advisory +on the "Security" tab of this GitHub repository. See [GitHub Security +Advisories](#github-security-advisories) to learn more about the security +infrastructure in GitHub. + +[GitHub security vulnerability report]: https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability + +## CNA/CVE Reporting + +Hyperledger Indy maintains a list of **Common Vulnerabilities and Exposures +(CVE)** and uses GitHub as its **CVE numbering authority (CNA)** for issuing +CVEs. + +## Embargo List + +Hyperledger Indy does **NOT** currently maintain a private embargo list. + +If you wish to be added to the embargo list, please email the [Hyperledger +Foundation security mailing list](mailto:security@lists.hyperledger.org), +including the project name (Hyperledger Indy) and reason for being added +to the embargo list. Requests will be assessed by the Hyperledger Indy +security team in conjunction with the appropriate Hyperledger Staff, and a +decision will be made to accommodate or not the request. + +For more information about embargo lists, please see the [Embargo List section +of the Hyperledger Security +Policy](https://toc.hyperledger.org/governing-documents/security.html#embargo-list). + +## (GitHub) Security Advisories + +Hyperledger Indy uses GitHub Security Advisories to manage the public +disclosure of security vulnerabilities. + +## Private Patch Deployment Infrastructure + +In creating patches and new releases that address security vulnerabilities, +Hyperledger Indy **MAY** use the private development features of GitHub for +security vulnerabilities. GitHub has [extensive +documentation](https://docs.github.com/en/code-security/security-advisories/repository-security-advisories) +about these features. diff --git a/build-scripts/ubuntu-2004/Dockerfile b/build-scripts/ubuntu-2004/Dockerfile index 5195c7b9d..a6ce96c34 100644 --- a/build-scripts/ubuntu-2004/Dockerfile +++ b/build-scripts/ubuntu-2004/Dockerfile @@ -22,7 +22,7 @@ RUN apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 9692C00E657DDE61 && # ======================================================================================================== # Plenum -# - https://github.com/hyperledger/indy-plenum/issues/1546 +# - https://github.com/hyperledger-indy/indy-plenum/issues/1546 # - Needed to pick up rocksdb=5.8.8 RUN echo "deb https://hyperledger.jfrog.io/artifactory/indy focal dev" >> /etc/apt/sources.list && \ echo "deb http://security.ubuntu.com/ubuntu bionic-security main" >> /etc/apt/sources.list && \ diff --git a/design/anoncreds.md b/design/anoncreds.md index 99e6dbaba..6606bd7db 100644 --- a/design/anoncreds.md +++ b/design/anoncreds.md @@ -15,7 +15,7 @@ Here you can find the requirements and design for Anoncreds workflow (including ## Anoncreds References Anoncreds protocol links: -- [Anoncreds Sequence Diagram](https://github.com/hyperledger/indy-sdk/blob/master/doc/libindy-anoncreds.svg) +- [Anoncreds Sequence Diagram](https://github.com/hyperledger-indy/indy-sdk/blob/master/doc/libindy-anoncreds.svg) - [Anoncreds Protocol Math](https://github.com/hyperledger/ursa-docs/tree/master/specs/anoncreds1) - [Anoncreds Protocol Crypto API](https://github.com/hyperledger/ursa/blob/master/libursa/docs/anoncreds-design.md) diff --git a/docs/source/1.3_to_1.4_migration_guide.md b/docs/source/1.3_to_1.4_migration_guide.md index f4089a1c8..304c0e2df 100644 --- a/docs/source/1.3_to_1.4_migration_guide.md +++ b/docs/source/1.3_to_1.4_migration_guide.md @@ -1,7 +1,7 @@ # List of breaking changes for migration from indy-node 1.3 to 1.4 -**Another format of REPLY for "WRITE" transactions**. New REPLY format you can see in: - [REPLY for "WRITE" txns](https://github.com/hyperledger/indy-node/blob/master/docs/source/requests.md#reply-structure-for-write-requests). + [REPLY for "WRITE" txns](https://github.com/hyperledger-indy/indy-node/blob/master/docs/source/requests.md#reply-structure-for-write-requests). The main goal for this changes is to divide data and metadata. -**Change key of ReqIdrToTxn stores**. For now, ReqIdrToTxn store request from client as a map of: @@ -9,8 +9,8 @@ Also, digest was moved to transaction metadata section. -**Added tag for CLAIM_DEF**. 'TAG' is a part of key for state tree. If this field exists in incoming transaction, then it will be used. If not, then default will be used. -Full CLAIM_DEF format description can be found in [CLAIM_DEF txn format](https://github.com/hyperledger/indy-node/blob/master/docs/source/transactions.md#claim_def) and [CLAIM_DEF request format](https://github.com/hyperledger/indy-node/blob/master/docs/source/requests.md#claim_def) -All of other request specifications are in: [Request](https://github.com/hyperledger/indy-node/blob/master/docs/source/requests.md) +Full CLAIM_DEF format description can be found in [CLAIM_DEF txn format](https://github.com/hyperledger-indy/indy-node/blob/master/docs/source/transactions.md#claim_def) and [CLAIM_DEF request format](https://github.com/hyperledger-indy/indy-node/blob/master/docs/source/requests.md#claim_def) +All of other request specifications are in: [Request](https://github.com/hyperledger-indy/indy-node/blob/master/docs/source/requests.md) -**Migration fom levelDB to RocksDB**. Rocksdb has a native 'seek' methods, more flexible, has snapshots support and works well on Windows. For now, all of internal node's storage use this db as a default key-value storages. @@ -18,11 +18,11 @@ For now, all of internal node's storage use this db as a default key-value stora Migration scripts, which would be called automatically during pool upgrade procedure (while sending POOL_UPGRADE transaction): - **Change REPLY format for WRITE transactions and using digest as a key**: - [1_3_428_to_1_3_429.py](https://github.com/hyperledger/indy-node/blob/master/data/migrations/deb/1_3_428_to_1_3_429.py) + [1_3_428_to_1_3_429.py](https://github.com/hyperledger-indy/indy-node/blob/master/data/migrations/deb/1_3_428_to_1_3_429.py) - **From levelDb to Rocksdb**: - [1_3_396_to_1_3_397.py](https://github.com/hyperledger/indy-node/blob/master/data/migrations/deb/1_3_396_to_1_3_397.py) + [1_3_396_to_1_3_397.py](https://github.com/hyperledger-indy/indy-node/blob/master/data/migrations/deb/1_3_396_to_1_3_397.py) ##### Significant notes about upgrade steps: diff --git a/docs/source/ci-cd.md b/docs/source/ci-cd.md index 4fd17b0af..29e5d9630 100644 --- a/docs/source/ci-cd.md +++ b/docs/source/ci-cd.md @@ -60,23 +60,23 @@ Use cases for artifacts ##### Build scripts We use [fpm](https://github.com/jordansissel/fpm) for packaging python code into deb packages. Build scripts are placed in `build-scripts` folders: -- https://github.com/hyperledger/indy-node/blob/main/build-scripts -- https://github.com/hyperledger/indy-plenum/blob/main/build-scripts +- https://github.com/hyperledger-indy/indy-node/blob/main/build-scripts +- https://github.com/hyperledger-indy/indy-plenum/blob/main/build-scripts We also pack some 3rd parties dependencies which are not presented in canonical ubuntu repositories: -- https://github.com/hyperledger/indy-node/tree/main/build-scripts/ubuntu-2004/build-3rd-parties.sh -- https://github.com/hyperledger/indy-plenum/tree/main/build-scripts//ubuntu-2004/build-3rd-parties.sh +- https://github.com/hyperledger-indy/indy-node/tree/main/build-scripts/ubuntu-2004/build-3rd-parties.sh +- https://github.com/hyperledger-indy/indy-plenum/tree/main/build-scripts//ubuntu-2004/build-3rd-parties.sh Each `build-scripts` folder includes `Readme.md`. Please check them for more details. #### Versioning - Please note, that we are using versioning that satisfies [PEP 440](https://www.python.org/dev/peps/pep-0440) with release segment as `MAJOR.MINOR.PATCH` that satisfies [SemVer](https://semver.org/) as well. -- Version is set in the code (see [\_\_version\_\_.json](https://github.com/hyperledger/indy-node/blob/main/indy_node/__version__.json)). -- Version is bumped for new releases / hotfixes either manually or using [bump_version.sh](https://github.com/hyperledger/indy-node/blob/main/indy_node/bump_version.sh) script. The latter is preferred. +- Version is set in the code (see [\_\_version\_\_.json](https://github.com/hyperledger-indy/indy-node/blob/main/indy_node/__version__.json)). +- Version is bumped for new releases / hotfixes either manually or using [bump_version.sh](https://github.com/hyperledger-indy/indy-node/blob/main/indy_node/bump_version.sh) script. The latter is preferred. - During development phase version includes developmental segment `devN`, where `N` is a unix timestamp at buildtime. - During release preparation phase (release / hotfix workflows) version includes pre-release segment `rcN`, where `N>=1` and set in the source code by developers. -- Each dependency (including indy-plenum) has a strict version (see [setup.py](https://github.com/hyperledger/indy-node/blob/main/setup.py)) +- Each dependency (including indy-plenum) has a strict version (see [setup.py](https://github.com/hyperledger-indy/indy-node/blob/main/setup.py)) - If you install indy-node (either from pypi, or from deb package), the specified in setup.py version of indy-plenum is installed. ## Release workflow diff --git a/docs/source/conf.py b/docs/source/conf.py index 5f665ce6e..eccf41bbf 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -228,7 +228,7 @@ def setup(app): if rtd_version not in ['stable', 'latest']: rtd_version = 'latest' try: - os.system("git clone https://github.com/hyperledger/indy-docs.git remote_conf") + os.system("git clone https://github.com/hyperledger-indy/indy-docs.git remote_conf") os.system("mv remote_conf/remote_conf.py .") import remote_conf remote_conf.generate_sidebar(globals(), nickname) diff --git a/docs/source/install-docs/AWS-NodeInstall-20.04.md b/docs/source/install-docs/AWS-NodeInstall-20.04.md index 63f962e17..34bb1d00a 100644 --- a/docs/source/install-docs/AWS-NodeInstall-20.04.md +++ b/docs/source/install-docs/AWS-NodeInstall-20.04.md @@ -6,7 +6,7 @@ NOTE: Since AWS regularly updates their user interface, this document becomes ou #### Installation -TIP: Make a copy of the [Node Installation Setup Spreadsheet Template](https://github.com/hyperledger/indy-node/blob/main/docs/source/install-docs/node-installation-info.xlsx) to store your Node information during installation. +TIP: Make a copy of the [Node Installation Setup Spreadsheet Template](https://github.com/hyperledger-indy/indy-node/blob/main/docs/source/install-docs/node-installation-info.xlsx) to store your Node information during installation. 1. Before you begin the installation steps, login to your AWS console and select a region to run your VM in. Recommendation: Select the region matching the jurisdiction of your company's corporate offices. 2. From the AWS EC2 services page, click 'Instances' @@ -342,4 +342,4 @@ TIP: Make a copy of the [Node Installation Setup Spreadsheet Template](https://g 6. On your 2FA phone app, add an account, and then scan the barcode or enter the 16 character secret key from step 4’s output. 7. Log out and then log back in to check and make sure it worked! 5. All of your secondary admin users should be setup now. -30. You can now begin the Indy Node installation using the [Validator Preparation Guide](https://github.com/hyperledger/indy-node/tree/main/docs/source/install-docs/validator-prep-20.04.md). +30. You can now begin the Indy Node installation using the [Validator Preparation Guide](https://github.com/hyperledger-indy/indy-node/tree/main/docs/source/install-docs/validator-prep-20.04.md). diff --git a/docs/source/install-docs/Azure-NodeInstall-20.04.md b/docs/source/install-docs/Azure-NodeInstall-20.04.md index 3de567b59..4c253547a 100644 --- a/docs/source/install-docs/Azure-NodeInstall-20.04.md +++ b/docs/source/install-docs/Azure-NodeInstall-20.04.md @@ -6,7 +6,7 @@ NOTE: Since Azure regularly updates their user interface, this document becomes #### Installation -TIP: Make a copy of the [Node Installation Setup Spreadsheet Template](https://github.com/hyperledger/indy-node/blob/main/docs/source/install-docs/node-installation-info.xlsx) to store your Node information during installation. +TIP: Make a copy of the [Node Installation Setup Spreadsheet Template](https://github.com/hyperledger-indy/indy-node/blob/main/docs/source/install-docs/node-installation-info.xlsx) to store your Node information during installation. 1. Create a new or open an existing “Resource Group” (“Create New” was used for this document.) You can also do this later. 2. From the Azure portal ‘home’ click 'Create a resource'. @@ -373,4 +373,4 @@ TIP: Make a copy of the [Node Installation Setup Spreadsheet Template](https://g 6. On your 2FA phone app, add an account, and then scan the barcode or enter the 16 character secret key from step 4’s output. 7. Log out and then log back in to check and make sure it worked! 5. All of your secondary admin users should be setup now. -30. You can now begin the Indy Node installation using the [Validator Preparation Guide](https://github.com/hyperledger/indy-node/tree/main/docs/source/install-docs/validator-prep-20.04.md). +30. You can now begin the Indy Node installation using the [Validator Preparation Guide](https://github.com/hyperledger-indy/indy-node/tree/main/docs/source/install-docs/validator-prep-20.04.md). diff --git a/docs/source/install-docs/GC-NodeInstall-20.04.md b/docs/source/install-docs/GC-NodeInstall-20.04.md index ca1b9cdb0..dde52483c 100644 --- a/docs/source/install-docs/GC-NodeInstall-20.04.md +++ b/docs/source/install-docs/GC-NodeInstall-20.04.md @@ -6,7 +6,7 @@ NOTE: Since GC regularly updates their user interface, this document becomes out #### Installation -TIP: Make a copy of the [Node Installation Setup Spreadsheet Template](https://github.com/hyperledger/indy-node/blob/main/docs/source/install-docs/node-installation-info.xlsx) to store your Node information during installation. +TIP: Make a copy of the [Node Installation Setup Spreadsheet Template](https://github.com/hyperledger-indy/indy-node/blob/main/docs/source/install-docs/node-installation-info.xlsx) to store your Node information during installation. 1. To prepare for VM creation, there are a few preliminary steps needed. First you might need to create a project in which you will create your VM. You will then need to set up items needed for Node networking (detailed steps below). You will also need to create a snapshot schedule so that your VM can be backed up automatically (optional, but this is the only method described herein that satisfies the "backup" requirement). 2. From the GCP console ([https://console.cloud.google.com/](https://console.cloud.google.com/)) scroll down in the upper left hamburger menu to the 'Networking' section, select 'VPC Network', then 'VPC Networks' If you haven’t already, you might need to “Enable” the compute engine API. @@ -378,4 +378,4 @@ TIP: Make a copy of the [Node Installation Setup Spreadsheet Template](https://g 6. On your 2FA phone app, add an account, and then scan the barcode or enter the 16 character secret key from step 4’s output. 7. Log out and then log back in to check and make sure it worked! 5. All of your secondary admin users should be setup now. -28. You can now begin the Indy Node installation using the [Validator Preparation Guide](https://github.com/hyperledger/indy-node/tree/main/docs/source/install-docs/validator-prep-20.04.md). +28. You can now begin the Indy Node installation using the [Validator Preparation Guide](https://github.com/hyperledger-indy/indy-node/tree/main/docs/source/install-docs/validator-prep-20.04.md). diff --git a/docs/source/install-docs/Physical-NodeInstall-20.04.md b/docs/source/install-docs/Physical-NodeInstall-20.04.md index f53c422f2..32952629e 100644 --- a/docs/source/install-docs/Physical-NodeInstall-20.04.md +++ b/docs/source/install-docs/Physical-NodeInstall-20.04.md @@ -5,7 +5,7 @@ The following steps are one way to adhere to the Indy Node guidelines for instal #### Installation -TIP: Make a copy of the [Node Installation Setup Spreadsheet Template](https://github.com/hyperledger/indy-node/blob/main/docs/source/install-docs/node-installation-info.xlsx) to store your Node information during installation. +TIP: Make a copy of the [Node Installation Setup Spreadsheet Template](https://github.com/hyperledger-indy/indy-node/blob/main/docs/source/install-docs/node-installation-info.xlsx) to store your Node information during installation. 1. Before you begin: 1. For most governance frameworks' hardware requirements, you will need 2 NIC's and 2 subnets (one per NIC). Configure these before beginning the install. @@ -222,4 +222,4 @@ TIP: Make a copy of the [Node Installation Setup Spreadsheet Template](https://g 6. On your 2FA phone app, add an account, and then scan the barcode or enter the 16 character secret key from step 4’s output. 7. Log out and then log back in to check and make sure it worked! 5. All of your secondary admin users should be setup now. -30. You can now begin the Indy Node installation using the [Validator Preparation Guide](https://github.com/hyperledger/indy-node/tree/main/docs/source/install-docs/validator-prep-20.04.md). +30. You can now begin the Indy Node installation using the [Validator Preparation Guide](https://github.com/hyperledger-indy/indy-node/tree/main/docs/source/install-docs/validator-prep-20.04.md). diff --git a/docs/source/install-docs/validator-prep-20.04.md b/docs/source/install-docs/validator-prep-20.04.md index ba6bea4c5..457d34244 100644 --- a/docs/source/install-docs/validator-prep-20.04.md +++ b/docs/source/install-docs/validator-prep-20.04.md @@ -23,12 +23,12 @@ By design, as a Node Operator, you are only allowed to operate one Validator nod ### 1.2. Hyperledger Indy and Indy-SDK -All Node Operators on a network run the same codebase. This codebase is open source Validator node software developed under the [Hyperledger Indy](https://github.com/hyperledger/indy-node) project hosted and managed by the [Linux Foundation](https://www.linuxfoundation.org/). This enables Node Operators (and everyone else in the ecosystem) to be confident in the code running the network. +All Node Operators on a network run the same codebase. This codebase is open source Validator node software developed under the [Hyperledger Indy](https://github.com/hyperledger-indy/indy-node) project hosted and managed by the [Linux Foundation](https://www.linuxfoundation.org/). This enables Node Operators (and everyone else in the ecosystem) to be confident in the code running the network. ## 2. Preliminaries to the Set Up -Before you start the Node set up process, you’ll need to have a place where you can store all of the following information. You can make a copy of the [Node Installation Setup Template](https://github.com/hyperledger/indy-node/blob/main/docs/source/install-docs/node-installation-info.xlsx) to use for saving the needed information. +Before you start the Node set up process, you’ll need to have a place where you can store all of the following information. You can make a copy of the [Node Installation Setup Template](https://github.com/hyperledger-indy/indy-node/blob/main/docs/source/install-docs/node-installation-info.xlsx) to use for saving the needed information. As you proceed through these steps, you will be generating data that will be needed later. As you follow the instructions and obtain the following, store them for later use: @@ -65,7 +65,7 @@ You’ll need two machines: one will be your Validator node and the other a CLI **Important:** For security reasons, you must NOT use your Validator node as a CLI machine. If you do, it could expose your Steward credentials needlessly. -Your Validator **must run Ubuntu 20.04 (64-bit)** as this guide covers instructions for that version only. To install your Ubuntu Validator you can follow some public step-by-step instructions created for that purpose. [Install Docs](https://github.com/hyperledger/indy-node/tree/main/docs/source/install-docs) +Your Validator **must run Ubuntu 20.04 (64-bit)** as this guide covers instructions for that version only. To install your Ubuntu Validator you can follow some public step-by-step instructions created for that purpose. [Install Docs](https://github.com/hyperledger-indy/indy-node/tree/main/docs/source/install-docs) This preparation guide recommends to use the [containerized Indy CLI](https://github.com/bcgov/von-network/blob/main/docs/Indy-CLI.md) in all environments and includes instructions only for that version. diff --git a/docs/source/node-add-troubleshooting.md b/docs/source/node-add-troubleshooting.md index c33f786f6..5199755e2 100644 --- a/docs/source/node-add-troubleshooting.md +++ b/docs/source/node-add-troubleshooting.md @@ -63,4 +63,4 @@ While this might seem a bit unusual, this two step "restart the network" has bee NOTE: Sometimes when a network begins to exhibit "split-brain" behaviours, in severe cases the symptoms will recur. A complete network reset may be required to remedy the issue if this happens on your network (or apply a future network upgrade that contains an undetermined fix). #### Looking for other sypmtoms? -For issues not covered here, there's also a great guide with some deeper troubleshooting tips: [Indy Network Troubleshooting]( https://github.com/hyperledger/indy-node/blob/main/docs/source/troubleshooting.md) +For issues not covered here, there's also a great guide with some deeper troubleshooting tips: [Indy Network Troubleshooting]( https://github.com/hyperledger-indy/indy-node/blob/main/docs/source/troubleshooting.md) diff --git a/docs/source/node-monitoring-tools-for-stewards.md b/docs/source/node-monitoring-tools-for-stewards.md index 5e2f1b510..acd5d80b0 100644 --- a/docs/source/node-monitoring-tools-for-stewards.md +++ b/docs/source/node-monitoring-tools-for-stewards.md @@ -9,7 +9,7 @@ Currently, indy-node emits different events via the Plugin Manager when certain criteria are met. The Plugin Manager tries to import all pip packages which names start with "indynotifier*". Each of these packages is required to expose `send_message`; interface which is used to pass the event with the associated message to the package for further handling. -The Plugin Manager code is located at [here](https://github.com/hyperledger/indy-plenum/blob/master/plenum/server/notifier_plugin_manager.py#L23). +The Plugin Manager code is located at [here](https://github.com/hyperledger-indy/indy-plenum/blob/master/plenum/server/notifier_plugin_manager.py#L23). ### Events Emitted diff --git a/docs/source/requests-new.md b/docs/source/requests-new.md index cbb1f63e8..d550668a0 100644 --- a/docs/source/requests-new.md +++ b/docs/source/requests-new.md @@ -31,9 +31,9 @@ This doc is about supported client"s Request (both write and read ones). If you are interested in transactions and their representation on the Ledger (that is internal one), then have a look at [transactions](transactions.md). -[indy-sdk](https://github.com/hyperledger/indy-sdk) expects the format as specified below. +[indy-sdk](https://github.com/hyperledger-indy/indy-sdk) expects the format as specified below. -See [roles and permissions](https://github.com/hyperledger/indy-node/blob/master/docs/source/auth_rules.md) on the roles and who can create each type of transactions. +See [roles and permissions](https://github.com/hyperledger-indy/indy-node/blob/master/docs/source/auth_rules.md) on the roles and who can create each type of transactions. ## Base Client-to-Node and Node-to-Node serialization @@ -413,7 +413,7 @@ The format of each request-specific data for each type of request. ### NYM Creates a new NYM record for a specific user, endorser, steward or trustee. -Note that only trustees and stewards can create new endorsers and trustee can be created only by other trusties (see [roles](https://github.com/hyperledger/indy-node/blob/master/docs/source/auth_rules.md)). +Note that only trustees and stewards can create new endorsers and trustee can be created only by other trusties (see [roles](https://github.com/hyperledger-indy/indy-node/blob/master/docs/source/auth_rules.md)). The request can be used for creation of new DIDs, setting and rotation of verification key, setting and changing of roles. @@ -434,7 +434,7 @@ creation of new DIDs, setting and rotation of verification key, setting and chan - 2 (STEWARD) - 101 (ENDORSER) - A TRUSTEE can change any Nym's role to None, this stopping it from making any writes (see [roles](https://github.com/hyperledger/indy-node/blob/master/docs/source/auth_rules.md)). + A TRUSTEE can change any Nym's role to None, this stopping it from making any writes (see [roles](https://github.com/hyperledger-indy/indy-node/blob/master/docs/source/auth_rules.md)). - `verkey` (base58-encoded string; optional): @@ -1390,7 +1390,7 @@ Command to change Pool's configuration ### LEDGERS_FREEZE -Freeze deprecated ledgers (default ledgers such as the domain, config, pool, and audit ledgers cannot be frozen). If a ledger is frozen it can be used for reading but not for writing. Frozen ledgers will not be caught up by new nodes and they can't be unfrozen. Frozen ledgers can be removed without breaking consensus, but this would prevent third parties from auditing the ledger history. [More information is in the Indy Plenum documenation](https://hyperledger/indy-plenum/tree/master/docs/source/transaction_freeze_ledgers.md). +Freeze deprecated ledgers (default ledgers such as the domain, config, pool, and audit ledgers cannot be frozen). If a ledger is frozen it can be used for reading but not for writing. Frozen ledgers will not be caught up by new nodes and they can't be unfrozen. Frozen ledgers can be removed without breaking consensus, but this would prevent third parties from auditing the ledger history. [More information is in the Indy Plenum documenation](https://hyperledger-indy/indy-plenum/tree/master/docs/source/transaction_freeze_ledgers.md). The request has static and dynamic validations. Static validation checks to avoid freezing base ledgers (pool, audit, domain and config). Dynamic validation checks the existence of ledgers before freezing. Authorize checks the permissions for the freeze request (3 trustee signatures are needed by default). diff --git a/docs/source/requests.md b/docs/source/requests.md index ce76c4eab..15b0ed477 100644 --- a/docs/source/requests.md +++ b/docs/source/requests.md @@ -55,7 +55,7 @@ This doc is about supported client's Request (both write and read ones). If you are interested in transactions and their representation on the Ledger (that is internal one), then have a look at [transactions](transactions.md). -[indy-sdk](https://github.com/hyperledger/indy-sdk) expects the format as specified below. +[indy-sdk](https://github.com/hyperledger-indy/indy-sdk) expects the format as specified below. See [roles and permissions](auth_rules.md) on the roles and who can create each type of transactions. @@ -513,7 +513,7 @@ The format of each request-specific data for each type of request. ### NYM Creates a new NYM record for a specific user, endorser, steward or trustee. -Note that only trustees and stewards can create new endorsers and trustee can be created only by other trustees (see [roles](https://github.com/hyperledger/indy-node/blob/master/docs/source/auth_rules.md)). +Note that only trustees and stewards can create new endorsers and trustee can be created only by other trustees (see [roles](https://github.com/hyperledger-indy/indy-node/blob/master/docs/source/auth_rules.md)). The request can be used for creation of new DIDs, setting, and rotation of verification key, setting and changing of roles. @@ -536,7 +536,7 @@ creation of new DIDs, setting, and rotation of verification key, setting and cha - "101" (ENDORSER) - "201" (NETWORK_MONITOR) - A TRUSTEE can change any Nym's role to None, this stopping it from making any writes (see [roles](https://github.com/hyperledger/indy-node/blob/master/docs/source/auth_rules.md)). + A TRUSTEE can change any Nym's role to None, this stopping it from making any writes (see [roles](https://github.com/hyperledger-indy/indy-node/blob/master/docs/source/auth_rules.md)). - `verkey` (base58-encoded string, possibly starting with "~"; optional): @@ -2967,7 +2967,7 @@ A new Agreement needs to be sent instead. ### LEDGERS_FREEZE -Freeze deprecated ledgers (default ledgers such as the domain, config, pool, and audit ledgers cannot be frozen). If a ledger is frozen it can be used for reading but not for writing. Frozen ledgers will not be caught up by new nodes and they can't be unfrozen. Frozen ledgers can be removed without breaking consensus, but this would prevent third parties from auditing the ledger history. [More information is in the Indy Plenum documenation](https://hyperledger/indy-plenum/tree/master/docs/source/transaction_freeze_ledgers.md). +Freeze deprecated ledgers (default ledgers such as the domain, config, pool, and audit ledgers cannot be frozen). If a ledger is frozen it can be used for reading but not for writing. Frozen ledgers will not be caught up by new nodes and they can't be unfrozen. Frozen ledgers can be removed without breaking consensus, but this would prevent third parties from auditing the ledger history. [More information is in the Indy Plenum documenation](https://hyperledger-indy/indy-plenum/tree/master/docs/source/transaction_freeze_ledgers.md). The request has static and dynamic validations. Static validation checks to avoid freezing base ledgers (pool, audit, domain and config). Dynamic validation checks the existence of ledgers before freezing. Authorize checks the permissions for the freeze request (3 trustee signatures are needed by default). diff --git a/docs/source/setup-iptables.md b/docs/source/setup-iptables.md index 058c8b31c..d127bbb5f 100644 --- a/docs/source/setup-iptables.md +++ b/docs/source/setup-iptables.md @@ -15,11 +15,11 @@ NOTE: You will need to have sudo privileges to work with iptables. ## Using indy scripts For ease of use and for people that are not familiar with iptables we've added two scripts: - - [`setup_iptables`](https://github.com/hyperledger/indy-node/blob/main/scripts/setup_iptables): + - [`setup_iptables`](https://github.com/hyperledger-indy/indy-node/blob/main/scripts/setup_iptables): - By default this scripts adds rules to iptables to limit the number of simultaneous clients connections for a specified port. - To get a full list of options run `./setup_iptables -h` from the scripts directory. - - [`setup_indy_node_iptables`](https://github.com/hyperledger/indy-node/blob/main/scripts/setup_indy_node_iptables): + - [`setup_indy_node_iptables`](https://github.com/hyperledger-indy/indy-node/blob/main/scripts/setup_indy_node_iptables): - A wrapper around `setup_iptables` which gets client port and connection limit settings from the `/etc/indy/indy.env` that is created by the `init_indy_node` script. Which one you use depends on how you installed indy-node on your server. Refer to the [For deb package based installations](#for-deb-package-based-installations), and [For pip based installations](#for-pip-based-installations) sections below. @@ -43,7 +43,7 @@ Before you run the scripts you should ensure you are using the latest scripts an 1. Download the latest version of the script. ``` - sudo curl -o /usr/local/bin/setup_iptables https://raw.githubusercontent.com/hyperledger/indy-node/main/scripts/setup_iptables + sudo curl -o /usr/local/bin/setup_iptables https://raw.githubusercontent.com/hyperledger-indy/indy-node/main/scripts/setup_iptables ``` The sha256 checksum for the current version of the script is `a0e4451cc49897dc38946091b245368c1f1360201f374a3ad121925f9aa80664` diff --git a/docs/source/start-nodes.md b/docs/source/start-nodes.md index 24c85887a..f690c72e5 100644 --- a/docs/source/start-nodes.md +++ b/docs/source/start-nodes.md @@ -1,6 +1,6 @@ # Create a Network and Start Nodes -Please be aware that recommended way of starting a pool is to [use Docker](https://github.com/hyperledger/indy-node/blob/master/environment/docker/pool/README.md). +Please be aware that recommended way of starting a pool is to [use Docker](https://github.com/hyperledger-indy/indy-node/blob/master/environment/docker/pool/README.md). In order to run your own Network, you need to do the following for each Node: 1. Install Indy Node @@ -81,7 +81,7 @@ There are at least two important reasons for this: - preventing the indy-node process from reaching of open file descriptors limit caused by clients connections - preventing the indy-node process from large memory usage as ZeroMQ creates the separate queue for each TCP connection. -Instructions related to iptables setup can be found [here](https://github.com/hyperledger/indy-node/blob/master/docs/source/setup-iptables.md). +Instructions related to iptables setup can be found [here](https://github.com/hyperledger-indy/indy-node/blob/master/docs/source/setup-iptables.md). #### Running Node diff --git a/docs/source/transactions.md b/docs/source/transactions.md index f7ca28c76..ad0fa3bd4 100644 --- a/docs/source/transactions.md +++ b/docs/source/transactions.md @@ -2108,7 +2108,7 @@ A new Agreement needs to be sent instead. #### LEDGERS_FREEZE -Freeze deprecated ledgers (default ledgers such as the domain, config, pool, and audit ledgers cannot be frozen). If a ledger is frozen it can be used for reading but not for writing. Frozen ledgers will not be caught up by new nodes and they can't be unfrozen. Frozen ledgers can be removed without breaking consensus, but this would prevent third parties from auditing the ledger history. [More information is in the Indy Plenum documenation](https://hyperledger/indy-plenum/tree/master/docs/source/transaction_freeze_ledgers.md). +Freeze deprecated ledgers (default ledgers such as the domain, config, pool, and audit ledgers cannot be frozen). If a ledger is frozen it can be used for reading but not for writing. Frozen ledgers will not be caught up by new nodes and they can't be unfrozen. Frozen ledgers can be removed without breaking consensus, but this would prevent third parties from auditing the ledger history. [More information is in the Indy Plenum documenation](https://hyperledger-indy/indy-plenum/tree/master/docs/source/transaction_freeze_ledgers.md). **Example:** ``` diff --git a/docs/source/troubleshooting.md b/docs/source/troubleshooting.md index 95abad721..bd9704201 100644 --- a/docs/source/troubleshooting.md +++ b/docs/source/troubleshooting.md @@ -18,9 +18,9 @@ Sole purpose of backup instances is to compare their performance to master insta Instances are numbered, master is always 0, and backups are assigned numbers starting from 1. When node is starting up or detects that it is lagging behind the rest of the pool it can start process of **catch up**, which is basically downloading (along with consistency checks) of latest parts of ledgers from other nodes and applying transactions to state. -More info about internals of Indy Node, including sequence diagrams of different processes can be found [here](https://github.com/hyperledger/indy-plenum/tree/master/docs/source/diagrams). +More info about internals of Indy Node, including sequence diagrams of different processes can be found [here](https://github.com/hyperledger-indy/indy-plenum/tree/master/docs/source/diagrams). -In order to be capable of automatically [upgrading](https://github.com/hyperledger/indy-node/blob/master/docs/source/pool-upgrade.md) itself Indy Node employs separate service called `indy-node-control`, which runs along with main service called `indy-node`. +In order to be capable of automatically [upgrading](https://github.com/hyperledger-indy/indy-node/blob/master/docs/source/pool-upgrade.md) itself Indy Node employs separate service called `indy-node-control`, which runs along with main service called `indy-node`. Also it is worth noting that `indy-node` service is configured to automatically restart node process in case it crashes. ### Types of failures @@ -40,22 +40,22 @@ However if more than _f_ nodes become affected then pool will not be able to do ### Where to get info Most useful places get info are the following: -- [Indy CLI](https://github.com/hyperledger/indy-sdk/tree/master/cli) can be used for sending read and write requests to pool, as well as checking general connectivity. -- Either VALIDATOR_INFO command sent through Indy CLI (in case of Sovrin network you'll need to have keys for priveleged DID to do so), or [validator-info](https://github.com/hyperledger/indy-node/blob/master/design/validator_info.md) script run on validator node. +- [Indy CLI](https://github.com/hyperledger-indy/indy-sdk/tree/master/cli) can be used for sending read and write requests to pool, as well as checking general connectivity. +- Either VALIDATOR_INFO command sent through Indy CLI (in case of Sovrin network you'll need to have keys for priveleged DID to do so), or [validator-info](https://github.com/hyperledger-indy/indy-node/blob/master/design/validator_info.md) script run on validator node. These tools provide important information like how many nodes are connected to each other, when last write happened (due to freshness check it should happen at least once per 5 minutes), whether a view change is in progress now or other important data, which is useful to assess pool current health and can be a starting point for further investigation, when needed. - `journalctl` logs can be useful because they contain tracebacks of indy-node crashes, if they happened, and these logs are really easy to check. Sometime crashes can be due to some bugs in code, but also they can be caused by insufficient resource (either memory or disk space), and if this is the case `journalctl` logs can provide a quick answer. - Indy node logs, located in `/var/log/indy//`. They can provide a lot of historical information, and very often are enough to get enough clues in order to properly diagnose situation, however they can be hard to read for unprepared. Lately most of the time it was enough to use `grep` and `sort` command-line tools to analyze them (although we'd recommend using [ripgrep](https://github.com/BurntSushi/ripgrep/releases) instead of plain grep, as it has quite a bunch of usability and performance improvements over traditional grep, while having compatible interface and no extra dependencies). - However we also have a [process_logs](https://github.com/hyperledger/indy-plenum/tree/master/scripts/process_logs) utility script, which also can be useful. + However we also have a [process_logs](https://github.com/hyperledger-indy/indy-plenum/tree/master/scripts/process_logs) utility script, which also can be useful. More info about them will be provided in next sections. - Indy node control tool logs, located in `/var/log/indy/node_control.log`. They can be useful when investigating upgrade-related problems. - In case of Sovrin network there are public websites showing contents of different ledgers, even if network is down (they basically mirror ledgers in their local database). We find most user-friendly one to be [indyscan.io](https://indyscan.io). This can be useful as a quick check whether some transaction type was written in the past when investigating transaction-specific problems. -- When in doubt about connectivity issues due to misconfigured firewalls or DPI a purpose-build tool [test_zmq](https://github.com/hyperledger/indy-plenum/blob/master/scripts/test_zmq/README.md) can be used. +- When in doubt about connectivity issues due to misconfigured firewalls or DPI a purpose-build tool [test_zmq](https://github.com/hyperledger-indy/indy-plenum/blob/master/scripts/test_zmq/README.md) can be used. - Debug metrics. They are turned off by default, but can be turned on by adding `METRICS_COLLECTOR_TYPE = 'kv'` to `/etc/indy/indy_config.py` and restarting node. Tools for processing these metrics are scripts `process_logs` and `build_graph_from_csv` bundled with Indy Node. @@ -95,7 +95,7 @@ In case of client-visible incidents first of all assess how bad situation is and Nodes IPs and ports can be found in pool ledger, which should be present on client. In case of Sovrin network nodes addresses also could be found from some 3rd party sites like [indyscan.io](https://indyscan.io). - If nodes are inaccessible from client check whether nodes are actually running and firewalls are configured properly (by asking corresponding Stewards). - When coordinating with Stewards an additional [purpose-built tool](https://github.com/hyperledger/indy-plenum/blob/master/scripts/test_zmq/README.md) can be used for checking ZeroMQ connectivity. + When coordinating with Stewards an additional [purpose-built tool](https://github.com/hyperledger-indy/indy-plenum/blob/master/scripts/test_zmq/README.md) can be used for checking ZeroMQ connectivity. - If nodes are running, but do not respond - check journalctl logs, there is a high change that nodes are perpetually crashing while trying to start up. This needs investigation (but usually it shouldn't take too long, since stack trace is available) and fixing source code. - If it is implossible to write to ledger @@ -197,7 +197,7 @@ Indy Node pool can function even with some nodes failing, however it is better t - 46-51 - these codes are connected to promotions or demotions of validator nodes, and: - either indicate that some nodes were promoted or demoted, in which case pool need to choose a new primary, hence votes for view change - or indicate some transient problems when selecting new primary after changing number of nodes, so yet another view change is needed - - other suspicion codes can be found [here](https://github.com/hyperledger/indy-plenum/blob/master/plenum/server/suspicion_codes.py) + - other suspicion codes can be found [here](https://github.com/hyperledger-indy/indy-plenum/blob/master/plenum/server/suspicion_codes.py) - `started view change to view` - this marks start of view change - `finished view change to view` - view change service accepted NEW_VIEW message (so there is enough connectivity between honest nodes to reach consensus), however there are some cases when ordering in new view fails and another view change will be needed - `started participating` - node finished all side activities (like catch up or view change) and started participating in consensus diff --git a/environment/docker/baseimage/Makefile b/environment/docker/baseimage/Makefile index ddf2a1de2..3671982a7 100644 --- a/environment/docker/baseimage/Makefile +++ b/environment/docker/baseimage/Makefile @@ -50,7 +50,7 @@ publish: clean $(BASE_CI_CORE_IMAGE_NAME) @echo "Done" clean-docker: - docker images -q hyperledger/indy-* | xargs -r docker rmi -f + docker images -q hyperledger-indy/indy-* | xargs -r docker rmi -f -rm -f $(patsubst %,$(BUILD_DIR)/%, $(IMAGES)) clean: diff --git a/environment/docker/baseimage/README.md b/environment/docker/baseimage/README.md index 80baf3d9f..ff2d0f9f8 100644 --- a/environment/docker/baseimage/README.md +++ b/environment/docker/baseimage/README.md @@ -29,8 +29,8 @@ Adds [Indy Core apt repository](https://repo.sovrin.org/deb) to apt sources.list ### indy-core-baseci Base image for images that provide CI testing environment for Indy core projects -[indy-plenum](https://github.com/hyperledger/indy-plenum), -[indy-node](https://github.com/hyperledger/indy-node)). +[indy-plenum](https://github.com/hyperledger-indy/indy-plenum), +[indy-node](https://github.com/hyperledger-indy/indy-node)). Based on [indy-baseci](#indy-baseci). Adds [Indy SDK apt repository](https://repo.sovrin.org/sdk/deb) to apt sources.list and configures apt preferences to make indy sdk packages from Indy Core apt repo more prioritized than from Indy SDK repo. @@ -55,6 +55,6 @@ Thus, the following release workflow is expected: 1. update dockerfile(s) and/or related resources 2. bump versions in `*.version` and base images tags in `*.dockerfile` accordingly. **Note**: each update in one of base images leads to version update for the child images as well - 3. create PR to [master](https://github.com/hyperledger/indy-node/tree/master/) - 4. pull [master](https://github.com/hyperledger/indy-node/tree/master/) locally once it is merged + 3. create PR to [master](https://github.com/hyperledger-indy/indy-node/tree/master/) + 4. pull [master](https://github.com/hyperledger-indy/indy-node/tree/master/) locally once it is merged 5. do `make publish` diff --git a/environment/docker/pool/client.ubuntu.dockerfile b/environment/docker/pool/client.ubuntu.dockerfile index 63c90b83d..0721f7da9 100644 --- a/environment/docker/pool/client.ubuntu.dockerfile +++ b/environment/docker/pool/client.ubuntu.dockerfile @@ -15,7 +15,7 @@ USER root # Install indy-cli RUN apt-get update -y && apt-get install -y libindy indy-cli # Install load script -RUN pip3 install -e 'git+https://github.com/hyperledger/indy-node.git@master#egg=subdir&subdirectory=scripts/performance' +RUN pip3 install -e 'git+https://github.com/hyperledger-indy/indy-node.git@master#egg=subdir&subdirectory=scripts/performance' USER indy # Init pool data diff --git a/environment/openshift/README.md b/environment/openshift/README.md index 0ae2cfcdf..4d203e799 100644 --- a/environment/openshift/README.md +++ b/environment/openshift/README.md @@ -1,4 +1,4 @@ -This client is deprecated! Please, use the new libindy-based CLI: https://github.com/hyperledger/indy-sdk/tree/master/cli +This client is deprecated! Please, use the new libindy-based CLI: https://github.com/hyperledger-indy/indy-sdk/tree/master/cli ________________________________________________________________________ # Getting Started diff --git a/environment/openshift/oc_configure_builds.sh b/environment/openshift/oc_configure_builds.sh index 905d21661..51fffb93e 100755 --- a/environment/openshift/oc_configure_builds.sh +++ b/environment/openshift/oc_configure_builds.sh @@ -36,7 +36,7 @@ if [ -z "$GIT_REF" ]; then fi if [ -z "$GIT_URI" ]; then - GIT_URI="https://github.com/hyperledger/indy-node.git" + GIT_URI="https://github.com/hyperledger-indy/indy-node.git" echo "Defaulting 'GIT_URI' to ${GIT_URI} ..." echo fi diff --git a/environment/openshift/templates/buildConfig.json b/environment/openshift/templates/buildConfig.json index ffabbd609..b2210c86a 100644 --- a/environment/openshift/templates/buildConfig.json +++ b/environment/openshift/templates/buildConfig.json @@ -207,7 +207,7 @@ "displayName": "Git Uri", "description": "The git Uri.", "required": true, - "value": "https://github.com/hyperledger/indy-node.git" + "value": "https://github.com/hyperledger-indy/indy-node.git" }, { "name": "DOCKER_FILE_PATH", diff --git a/environment/vagrant/sandbox/DevelopmentEnvironment/AWS/scriptlets/common/pre/linux/yum/setup b/environment/vagrant/sandbox/DevelopmentEnvironment/AWS/scriptlets/common/pre/linux/yum/setup index d3d67349c..77dfb76ef 100644 --- a/environment/vagrant/sandbox/DevelopmentEnvironment/AWS/scriptlets/common/pre/linux/yum/setup +++ b/environment/vagrant/sandbox/DevelopmentEnvironment/AWS/scriptlets/common/pre/linux/yum/setup @@ -21,7 +21,7 @@ sed -i -- 's/^releasever=latest/#releasever=latest/' /etc/yum.conf #-------------------------------------------------------- # The following steps were derived from: -# https://github.com/hyperledger/indy-sdk +# https://github.com/hyperledger-indy/indy-sdk # NOTE: Add links to README files here if you add any additional repos # to the development_repos hash (ruby code above) diff --git a/environment/vagrant/sandbox/DevelopmentEnvironment/AWS/scriptlets/indy-sdk/linux/pre/setup b/environment/vagrant/sandbox/DevelopmentEnvironment/AWS/scriptlets/indy-sdk/linux/pre/setup index cb8113cf2..b45db7b65 100644 --- a/environment/vagrant/sandbox/DevelopmentEnvironment/AWS/scriptlets/indy-sdk/linux/pre/setup +++ b/environment/vagrant/sandbox/DevelopmentEnvironment/AWS/scriptlets/indy-sdk/linux/pre/setup @@ -5,7 +5,7 @@ USER=ec2-user # # The following part of this script was derived from: # "Setup Indy SDK build environment for RHEL based distro (Amazon Linux 2017.03)" -# https://github.com/hyperledger/indy-sdk/blob/master/docs/build-guides/rhel-build.md +# https://github.com/hyperledger-indy/indy-sdk/blob/master/docs/build-guides/rhel-build.md echo "Installing Rust and rustup non-interactively as ${USER}..." echo "Note that rustup typically runs interactively and allows you to " diff --git a/environment/vagrant/sandbox/DevelopmentEnvironment/Virtualbox/Vagrantfile b/environment/vagrant/sandbox/DevelopmentEnvironment/Virtualbox/Vagrantfile index 7d5db2543..e19a84d9d 100644 --- a/environment/vagrant/sandbox/DevelopmentEnvironment/Virtualbox/Vagrantfile +++ b/environment/vagrant/sandbox/DevelopmentEnvironment/Virtualbox/Vagrantfile @@ -336,7 +336,7 @@ pip3 install docker #-------------------------------------------------------- # The following steps were derived from: -# https://github.com/hyperledger/indy-sdk/blob/master/docs/build-guides/ubuntu-build.md +# https://github.com/hyperledger-indy/indy-sdk/blob/master/docs/build-guides/ubuntu-build.md # echo "Installing Rust and rustup non-interactively as user vagrant ..." echo "Note that rustup typically runs interactively and allows you to " diff --git a/environment/vagrant/training/vb-multi-vm/TestIndyClusterSetup.md b/environment/vagrant/training/vb-multi-vm/TestIndyClusterSetup.md index 46bef25eb..47ce4396a 100644 --- a/environment/vagrant/training/vb-multi-vm/TestIndyClusterSetup.md +++ b/environment/vagrant/training/vb-multi-vm/TestIndyClusterSetup.md @@ -1,10 +1,10 @@ # Setting Up a Test Indy Network in VMs **WARNING**: This guideline assumes using of a deprecated CLI and deprecated Getting Started Guide. -Please have a look at [new client from SDK](https://github.com/hyperledger/indy-sdk/tree/master/cli) and new [Getting Started Guide](https://github.com/hyperledger/indy-sdk/blob/master/doc/getting-started/getting-started.md) instead. +Please have a look at [new client from SDK](https://github.com/hyperledger-indy/indy-sdk/tree/master/cli) and new [Getting Started Guide](https://github.com/hyperledger-indy/indy-sdk/blob/master/doc/getting-started/getting-started.md) instead. When you're finished working through this document, you will be able to proceed through to the [*Getting -Started Guide*](../../../../getting-started.md) or if you would like, you may continue setting up an actual Developer Environment connected to a sandbox by following these [instructions](https://github.com/hyperledger/indy-node/blob/master/environment/vagrant/sandbox/DevelopmentEnvironment/Virtualbox/Vagrantfile). +Started Guide*](../../../../getting-started.md) or if you would like, you may continue setting up an actual Developer Environment connected to a sandbox by following these [instructions](https://github.com/hyperledger-indy/indy-node/blob/master/environment/vagrant/sandbox/DevelopmentEnvironment/Virtualbox/Vagrantfile). This document will guide you in configuring a private network of Indy validator nodes for testing and learning about Indy. Additional servers @@ -73,7 +73,7 @@ the quickest way to get all the necessary files (plus more). Then navigate to t directory containing the scripts. ```sh -$ git clone https://github.com/hyperledger/indy-node.git +$ git clone https://github.com/hyperledger-indy/indy-node.git $ cd indy-node/environment/vagrant/training/vb-multi-vm $ git checkout stable ``` diff --git a/indy_node/__metadata__.py b/indy_node/__metadata__.py index 1603cb026..026ae4598 100644 --- a/indy_node/__metadata__.py +++ b/indy_node/__metadata__.py @@ -58,7 +58,7 @@ def set_manifest(manifest: Any, manifest_file: str = MANIFEST_FILE): __description__ = 'Indy node' __long_description__ = __description__ __keywords__ = 'Indy Node' -__url__ = 'https://github.com/hyperledger/indy-node' +__url__ = 'https://github.com/hyperledger-indy/indy-node' __author__ = "Hyperledger" __author_email__ = 'hyperledger-indy@lists.hyperledger.org' __maintainer__ = "Hyperledger" diff --git a/indy_node/test/rich_schema/templates.py b/indy_node/test/rich_schema/templates.py index aa127caf1..26ae30f5b 100644 --- a/indy_node/test/rich_schema/templates.py +++ b/indy_node/test/rich_schema/templates.py @@ -86,10 +86,10 @@ }, "algorithm": { "description": "This encoding transforms an RFC3339 - formatted datetime object into the number of seconds since January 1, 1970(the Unix epoch).", - "documentation": "https://github.com/hyperledger/indy-hipe/commit/3a39665fd384254f08316eef6230c2f411b8f765", - "implementation": "https://github.com/hyperledger/indy-hipe/commit/3a39665fd384254f08316eef6230c2f411b8f869", + "documentation": "https://github.com/hyperledger-indy/indy-hipe/commit/3a39665fd384254f08316eef6230c2f411b8f765", + "implementation": "https://github.com/hyperledger-indy/indy-hipe/commit/3a39665fd384254f08316eef6230c2f411b8f869", }, - "testVectors": "https://github.com/hyperledger/indy-hipe/commit/3a39665fd384254f08316eef6230c2f411b8f766" + "testVectors": "https://github.com/hyperledger-indy/indy-hipe/commit/3a39665fd384254f08316eef6230c2f411b8f766" } RICH_SCHEMA_EX1 = { diff --git a/pool_automation/roles/perf_scripts/tasks/main.yml b/pool_automation/roles/perf_scripts/tasks/main.yml index 3b837207f..aacf2c502 100644 --- a/pool_automation/roles/perf_scripts/tasks/main.yml +++ b/pool_automation/roles/perf_scripts/tasks/main.yml @@ -55,7 +55,7 @@ - name: Install performance scripts from the VCS pip: - name: "git+https://github.com/hyperledger/indy-node.git@{{ perf_scripts_ver }}#egg=subdir&subdirectory=scripts/performance" + name: "git+https://github.com/hyperledger-indy/indy-node.git@{{ perf_scripts_ver }}#egg=subdir&subdirectory=scripts/performance" virtualenv: "$HOME/{{ perf_scripts_venv_name }}" # $HOME as a workaround virtualenv_python: python3 diff --git a/scripts/performance/perf_load/__version__.py b/scripts/performance/perf_load/__version__.py index 770f3e930..bc1382f8b 100644 --- a/scripts/performance/perf_load/__version__.py +++ b/scripts/performance/perf_load/__version__.py @@ -8,7 +8,7 @@ __description__ = 'Indy node performance load' __long_description__ = __description__ __keywords__ = 'indy node performance load testing' -__url__ = 'https://github.com/hyperledger/indy-node/tree/master/scripts/performance' +__url__ = 'https://github.com/hyperledger-indy/indy-node/tree/master/scripts/performance' __author__ = "Hyperledger" __author_email__ = 'hyperledger-indy@lists.hyperledger.org' __maintainer__ = "Hyperledger" diff --git a/scripts/performance/perf_load/perf_processes.py b/scripts/performance/perf_load/perf_processes.py index 13a61faa7..63ba9bb7e 100755 --- a/scripts/performance/perf_load/perf_processes.py +++ b/scripts/performance/perf_load/perf_processes.py @@ -28,7 +28,7 @@ parser = argparse.ArgumentParser(description='The script generates bunch of txns for the pool with Indy SDK. ' - 'Detailed description: https://github.com/hyperledger/indy-node/docs/process-based-load-script.md') + 'Detailed description: https://github.com/hyperledger-indy/indy-node/docs/process-based-load-script.md') parser.add_argument('-c', '--clients', default=0, type=int, required=False, dest='clients', help='Number of client you want to create. ' diff --git a/setup.py b/setup.py index 165ea3ace..c248a06d9 100644 --- a/setup.py +++ b/setup.py @@ -61,7 +61,7 @@ # importlib-metadata needs to be pinned to 3.10.1 because from v4.0.0 the package # name ends in python3-importlib-metadata_0.0.0_amd64.deb # see also build-scripts/ubuntu-2004/build-3rd-parties.sh - # https://github.com/hyperledger/indy-plenum/blob/eac38674252b539216be2c40bb13e53c5b70dad2/build-scripts/ubuntu-2004/build-3rd-parties.sh#L104-L106 + # https://github.com/hyperledger-indy/indy-plenum/blob/eac38674252b539216be2c40bb13e53c5b70dad2/build-scripts/ubuntu-2004/build-3rd-parties.sh#L104-L106 'importlib-metadata==3.10.1', 'timeout-decorator>=0.5.0', 'distro==1.7.0'],