diff --git a/.github/workflows/crates-auto-publish-workflow.yml b/.github/workflows/crates-auto-publish-workflow.yml deleted file mode 100644 index 9a24fd538..000000000 --- a/.github/workflows/crates-auto-publish-workflow.yml +++ /dev/null @@ -1,49 +0,0 @@ -# This Github Action is designed to automatically publish Crate packages. -# -# While this Github Action will often be triggered, it will only publish a new package -# if the version specified in the cargo.toml file(s) is behind that already published. -# -# Further documentation on how this webhook works can be found at the following URL: -# https://github.com/marketplace/actions/publish-crates - -name: "Crates Auto Publish Workflow" - -on: - workflow_call: - inputs: - environment: - description: | - Choose from which environment to run this workflow - required: true - type: string - package-path: - description: | - Provide the path to your package.json file - required: true - type: string - secrets: - publish-token: - required: true - -jobs: - build: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - name: Build - run: cargo build --verbose --manifest-path ${{ inputs.package-path }} - - name: Run tests - run: cargo test --verbose --manifest-path ${{ inputs.package-path }} - - publish-cargo: - needs: build - runs-on: ubuntu-latest - environment: ${{ inputs.environment }} - steps: - - uses: actions/checkout@v3 - - name: publish package - uses: katyo/publish-crates@v1 - with: - path: ${{ inputs.package-path }} - registry-token: ${{ secrets.publish-token }} - ignore-unpublished-changes: true \ No newline at end of file diff --git a/.github/workflows/crates-auto-publish.yml b/.github/workflows/crates-auto-publish.yml deleted file mode 100644 index 55f1206b7..000000000 --- a/.github/workflows/crates-auto-publish.yml +++ /dev/null @@ -1,22 +0,0 @@ -name: "Cargo Crates Auto Publish" - -on: - push: - branches: - - main - - develop - paths: - - "solana/program_v2/programs/gateway_v2/Cargo.toml" - -env: - CARGO_TERM_COLOR: always - -jobs: - - publish-gateway: - uses: "./.github/workflows/crates-auto-publish-workflow.yml" - with: - environment: "crates-auto-publish" - package-path: "solana/program_v2/programs/gateway_v2/Cargo.toml" - secrets: - publish-token: ${{ secrets.CARGO_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/npm-auto-publish-workflow.yml b/.github/workflows/npm-auto-publish-workflow.yml deleted file mode 100644 index 1ba7ff580..000000000 --- a/.github/workflows/npm-auto-publish-workflow.yml +++ /dev/null @@ -1,84 +0,0 @@ -# This Github Action is designed to automatically publish NPM packages. -# -# While this Github Action will often be triggered, it will only publish a new package -# if the version specified in the package.json file(s) is behind that already published. -# -# Further documentation on how this webhook works can be found at the following URL: -# https://github.com/marketplace/actions/npm-publish - -name: "NPM Auto Publish Workflow" - -on: - workflow_call: - inputs: - environment: - description: | - Choose from which environment to run this workflow - required: true - type: string - production-branch: - description: | - Changes pushed to this branch will always be tagged with a "latest" tag - Any other branch will default to receiving an "alpha" tag. - required: true - type: string - root-directory: - description: | - Provide the path to your package's root working directory - required: true - type: string - package-path: - description: | - Provide the path to your package.json file - required: true - type: string - secrets: - publish-token: - required: true - -jobs: - publish-npm: - environment: ${{ inputs.environment }} - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - - uses: actions/setup-node@v3 - with: - node-version: 16 - registry-url: https://registry.npmjs.org/ - - - name: Extract Tag Value - id: extract-tag-value - shell: bash - run: | - if [ "${GITHUB_REF##*/}" == "${{ inputs.production-branch }}" ]; then - echo "Using 'Latest' Tag" - echo "tag-value=latest" >> $GITHUB_OUTPUT - else - echo "Using 'Beta' Tag" - echo "tag-value=beta" >> $GITHUB_OUTPUT - fi - - # YARN workspaces should not be used when publishing individual packages out of a monorepo. - # Workspaces are convenient for development as they link and share local files. - # When publishing, however, we want to disable workspaces and force dependencies to be imported from NPM. - # This prevents releasing packages which can build in our workspace, but not in a standalone environment. - # - # More details are captured in the 'Limitations & Caveats' section on: - # https://classic.yarnpkg.com/lang/en/docs/workspaces/ - # - # Unfortunately YARN doesn't seem to provide a simple way to turn off workspaces other than to remove the - # 'workspaces' key from the root package.json file (which is what this step performs). - - name: Remove workspace configuration - working-directory: ${{ inputs.root-directory }} - run: | - jq 'del(.workspaces)' package.json >> package-edited.json - mv package-edited.json package.json - - - name: NPM Publish Package - uses: JS-DevTools/npm-publish@v1 - with: - token: ${{ secrets.publish-token }} - package: ${{ inputs.package-path }} - check-version: true - tag: ${{ steps.extract-tag-value.outputs.tag-value }} \ No newline at end of file diff --git a/.github/workflows/npm-auto-publish.yml b/.github/workflows/npm-auto-publish.yml deleted file mode 100644 index b043b37ae..000000000 --- a/.github/workflows/npm-auto-publish.yml +++ /dev/null @@ -1,45 +0,0 @@ -name: "NPM Auto Publish" - -on: - push: - branches: - - main - - develop - - paths: - - "solana/program_v2/packages/client/cli/package.json" - - "solana/program_v2/packages/client/core/package.json" - - "solana/program_v2/packages/client/idl/package.json" - -jobs: - publish-gateway-solana-idl: - uses: "./.github/workflows/npm-auto-publish-workflow.yml" - with: - environment: "npm-auto-publish" - production-branch: "main" - root-directory: "solana/program_v2" - package-path: "solana/program_v2/packages/client/idl/package.json" - secrets: - publish-token: ${{ secrets.NPM_TOKEN }} - - publish-gateway-solana-client: - needs: publish-gateway-solana-idl - uses: "./.github/workflows/npm-auto-publish-workflow.yml" - with: - environment: "npm-auto-publish" - production-branch: "main" - root-directory: "solana/program_v2" - package-path: "solana/program_v2/packages/client/core/package.json" - secrets: - publish-token: ${{ secrets.NPM_TOKEN }} - - publish-gateway-solana-cli: - needs: publish-gateway-solana-client - uses: "./.github/workflows/npm-auto-publish-workflow.yml" - with: - environment: "npm-auto-publish" - production-branch: "main" - root-directory: "solana/program_v2" - package-path: "solana/program_v2/packages/client/cli/package.json" - secrets: - publish-token: ${{ secrets.NPM_TOKEN }} \ No newline at end of file diff --git a/.github/workflows/program-auto-publish-workflow.yml b/.github/workflows/program-auto-publish-workflow.yml deleted file mode 100644 index 218d485aa..000000000 --- a/.github/workflows/program-auto-publish-workflow.yml +++ /dev/null @@ -1,105 +0,0 @@ -name: "Program Auto Publish Workflow" - -on: - workflow_call: - inputs: - environment: - description: | - Choose from which environment to run this workflow - required: true - type: string - package-path: - description: | - Provide the path to your Cargo.toml file - required: true - type: string - program-address: - description: | - Provide the program address - required: true - type: string - solana-version: - description: | - The Solana version to build against - required: true - type: string - rust-version: - description: | - The Rust version to build against - required: true - type: string - working-directory: - description: | - The working directory for the project to build - required: false - default: './' - type: string - solana-environment: - description: | - The solana environment to deploy to - required: true - type: string - program-binary: - description: | - The program binary to deploy - required: true - type: string - secrets: - program-authority: - required: true - description: | - The Solana authority for updating the program - -jobs: - build-deploy: - name: Deploy the program, built on Solana ${{ inputs.solana-version }}, Rust ${{ inputs.rust-version }}, and ${{ matrix.os }} - runs-on: ${{ matrix.os }} - environment: ${{ inputs.environment }} - strategy: - matrix: - os: [ ubuntu-latest ] - - steps: - - name: Checkout repo - uses: actions/checkout@v2 - - - name: Use Rust ${{ inputs.rust-version }} - uses: actions-rs/toolchain@v1 - with: - toolchain: ${{ inputs.rust-version }} - - - name: Cache build dependencies - uses: actions/cache@v2 - with: - path: | - ~/.cargo/registry - ~/.cargo/git - ./program/target - key: cargo-build-${{ hashFiles('solana/program_v2/Cargo.lock') }} - - - name: Cache Solana version - uses: actions/cache@v2 - with: - path: | - ~/.local/share/solana/ - key: solana-${{ inputs.solana-version }} - - - name: Install Solana - if: steps.cache-solana.outputs.cache-hit != 'true' - run: | - sh -c "$(curl -sSfL https://release.solana.com/${{ inputs.solana-version }}/install)" - echo "$HOME/.local/share/solana/install/active_release/bin" >> $GITHUB_PATH - - - name: Build programs - uses: actions-rs/cargo@v1 - with: - command: build-bpf - args: '--manifest-path ${{ inputs.working-directory }}/Cargo.toml' - - - name: Deploy dev program - working-directory: "./solana/program_v2" - run: | - echo "${{ secrets.program-authority }}" > ~/.config/solana/id.json - solana config set --url ${{ inputs.solana-environment}} - solana program deploy ${{ inputs.program-bin }} --program-id ${{ inputs.program-address }} - solana program show ${{ inputs.program-address }} \ No newline at end of file diff --git a/.github/workflows/program-auto-publish.yml b/.github/workflows/program-auto-publish.yml deleted file mode 100644 index aba018149..000000000 --- a/.github/workflows/program-auto-publish.yml +++ /dev/null @@ -1,27 +0,0 @@ -name: "Program Auto Publish" - -on: - push: - branches: - - develop - paths: - - "solana/program_v2/programs/gateway_v2/Cargo.toml" - -env: - CARGO_TERM_COLOR: always - -jobs: - - publish-gateway: - uses: "./.github/workflows/program-auto-publish-workflow.yml" - with: - environment: "program-auto-publish" - package-path: "solana/program_v2/programs/gateway_v2/Cargo.toml" - program-address: "gate2TBGydKNyMNUqz64s8bz4uaWS9PNreMbmAjb1Ft" - solana-version: "stable" - rust-version: "stable" - working-directory: "./solana/program_v2" - solana-environment: "devnet" - program-binary: "target/deploy/solana_anchor_gateway.so" - secrets: - program-authority: ${{ secrets.SOLANA_PROGRAM_AUTHORITY }} \ No newline at end of file diff --git a/.github/workflows/solana-rust.yml b/.github/workflows/solana-rust.yml index ba38a2d09..c3f911560 100644 --- a/.github/workflows/solana-rust.yml +++ b/.github/workflows/solana-rust.yml @@ -59,7 +59,7 @@ jobs: strategy: matrix: rust: [ '1.74' ] # This should match rust-toolchain.toml ( actions-rs/toolchain@v1 does not pick it up directly in monorepos ) - solana: [ 'edge' ] + solana: [ 'v1.18.18' ] os: [ ubuntu-latest ] steps: diff --git a/.github/workflows/solana-ts.yml b/.github/workflows/solana-ts.yml index f1e10d647..bce92cf56 100644 --- a/.github/workflows/solana-ts.yml +++ b/.github/workflows/solana-ts.yml @@ -56,7 +56,7 @@ jobs: # This should match rust-toolchain.toml ( actions-rs/toolchain@v1 does not pick it up directly in monorepos ) rust: ["1.74"] node: ["20.x"] - solana: ["edge"] + solana: ["v1.18.18"] os: [ubuntu-latest] defaults: diff --git a/.github/workflows/solana-v2-rust.yml b/.github/workflows/solana-v2-rust.yml deleted file mode 100644 index fa6116e33..000000000 --- a/.github/workflows/solana-v2-rust.yml +++ /dev/null @@ -1,162 +0,0 @@ -name: Gateway_V2 Program -on: - push: - paths: - - "solana/program_v2" - pull_request: -jobs: - program-lint: - name: Format and lint the Gateway V2 on-chain program on Rust ${{ matrix.rust }} and ${{ matrix.os }} - - runs-on: ${{ matrix.os }} - strategy: - matrix: - rust: [ "stable" ] - os: [ ubuntu-latest ] - - steps: - - name: Checkout repo - uses: actions/checkout@v2 - - - name: Use Rust ${{ matrix.rust }} - uses: actions-rs/toolchain@v1 - with: - toolchain: ${{ matrix.rust }} - override: true - profile: minimal - components: rustfmt, clippy - - - name: Run fmt - uses: actions-rs/cargo@v1 - with: - command: fmt - args: --manifest-path solana/program_v2/Cargo.toml --all -- --check - - - name: Cache dependencies - uses: actions/cache@v2 - with: - path: | - ~/.cargo/registry - ~/.cargo/git - ./solana/program_v2/target - key: cargo-clippy-${{ hashFiles('solana/program_v2/Cargo.lock') }} - - - name: Run Clippy - uses: actions-rs/cargo@v1 - with: - command: clippy - args: --manifest-path solana/program_v2/Cargo.toml --tests --workspace --all-targets -- --deny=warnings - - program-unit-test: - name: Unit test program on Rust ${{ matrix.rust }} and ${{ matrix.os }} - - runs-on: ${{ matrix.os }} - strategy: - matrix: - rust: [ "stable" ] - os: [ ubuntu-latest ] - - steps: - - name: Checkout repo - uses: actions/checkout@v2 - - - name: Use Rust ${{ matrix.rust }} - uses: actions-rs/toolchain@v1 - with: - toolchain: ${{ matrix.rust }} - override: true - profile: minimal - - - name: Cache build dependencies - uses: actions/cache@v2 - with: - path: | - ~/.cargo/registry - ~/.cargo/git - ./solana/program_v2/target - key: cargo-test-${{ hashFiles('solana/program_v2/Cargo.lock') }} - - - name: Run unit tests - uses: actions-rs/cargo@v1 - with: - command: test - args: --manifest-path solana/program_v2/Cargo.toml - - anchor-e2e-test: - name: Build, Lint Client and test the Gateway V2 on-chain program on Solana ${{ matrix.solana }}, Rust ${{ matrix.rust }}, node ${{ matrix.node }}, and ${{ matrix.os }} - - defaults: - run: - working-directory: ./solana/program_v2 - - runs-on: ${{ matrix.os }} - strategy: - matrix: - node: [ "16.x" ] - rust: [ "stable" ] - solana: [ "v1.14.16" ] - os: [ ubuntu-latest ] - - steps: - - name: Checkout repo - uses: actions/checkout@v2 - - - name: Use Rust ${{ matrix.rust }} - uses: actions-rs/toolchain@v1 - with: - toolchain: ${{ matrix.rust }} - override: true - profile: minimal - - - name: Cache build dependencies - uses: actions/cache@v2 - with: - path: | - ~/.cargo/registry - ~/.cargo/git - ./solana/program_v2/target - key: cargo-build-${{ hashFiles('solana/program_v2/Cargo.lock') }} - - - name: Cache Solana version - uses: actions/cache@v2 - with: - path: | - ~/.cache - key: solana-${{ matrix.solana }} - - - name: Install Solana - run: | - sh -c "$(curl -sSfL https://release.solana.com/${{ matrix.solana }}/install)" - echo "$HOME/.local/share/solana/install/active_release/bin" >> $GITHUB_PATH - - - name: Use Node ${{ matrix.node }} - uses: actions/setup-node@v1 - with: - node-version: ${{ matrix.node }} - - - name: Cache node dependencies - uses: actions/cache@v2 - with: - path: | - ./solana/program_v2/node_modules - key: yarn-client-${{ hashFiles('solana/program_v2/yarn.lock') }} - - - name: Install - run: yarn install --ignore-scripts --frozen-lockfile - - - name: Build program - run: yarn build - - - name: Lint - run: yarn lint - - - name: Run integration tests - run: | - yarn test - - # yarn anchor build - # - name: Upload a single artifact - # uses: actions/upload-artifact@v3 - # with: - # path: /solana/program_v2 - # name: latest-program_v2_version diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 981f96277..eaaab8ac1 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,5 +1,5 @@ # Open Source Code of Conduct -This code of conduct outlines our expectations for participants within the Identity.com Open Source community, as well as steps to reporting unacceptable behavior. We are committed to providing a welcoming and inspiring community for all and expect our code of conduct to be honored. Anyone who violates this code of conduct may be banned from the community. +This code of conduct outlines our expectations for participants within the Civic Open Source community, as well as steps to reporting unacceptable behavior. We are committed to providing a welcoming and inspiring community for all and expect our code of conduct to be honored. Anyone who violates this code of conduct may be banned from the community. # Our open source community strives to: @@ -33,7 +33,7 @@ Although this list cannot be exhaustive, we explicitly honor diversity in age, g # Reporting Issues -If you experience or witness unacceptable behavior—or have any other concerns—please report it by contacting us via https://www.identity.com/about/contact-us/. All reports will be handled with discretion. In your report please include: +If you experience or witness unacceptable behavior—or have any other concerns—please report it by contacting us via code-of-conduct@civic.com. All reports will be handled with discretion. In your report please include: * Your contact information. * Names (real, nicknames, or pseudonyms) of any individuals involved. If there are additional witnesses, please include them as well. Your account of what occurred, and if you believe the incident is ongoing. If there is a publicly available record (e.g. a mailing list archive or a public IRC logger), please include a link. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9fee083a6..31d767dcc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,11 +2,11 @@ We’re still working out the kinks to make contributing to this project as easy and transparent as possible, but we’re not quite there yet. Hopefully this document makes the process for contributing clear and answers some questions that you may have. # Code of Conduct -Identity.com has adopted a [Code of Conduct](CODE_OF_CONDUCT.md) that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated. +Civic has adopted a [Code of Conduct](CODE_OF_CONDUCT.md) that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated. # Contributors & Team Members Development -Most internal changes made by Civic & Identity.com engineers will be synced to GitHub. Civic & Identity.com use this code in production. The team is likely to have an enterprise version of the code containing specific environment details and that part is not synced with the code here. -Changes from the community are handled through GitHub pull requests which go through our review process. Once a change made on GitHub is approved, it will be imported to the Civic & Identity.com internal repositories. +Most internal changes made by Civic & Civic engineers will be synced to GitHub. Civic & Civic use this code in production. The team is likely to have an enterprise version of the code containing specific environment details and that part is not synced with the code here. +Changes from the community are handled through GitHub pull requests which go through our review process. Once a change made on GitHub is approved, it will be imported to the Civic & Civic internal repositories. # Branch Organization We will do our best to keep the master branch in good shape, with tests passing at all times. But in order to move fast, we will make API changes that your application might not be compatible with. We recommend that you use the latest stable and published version. @@ -24,7 +24,7 @@ The best way to get your bug fixed is to provide a reduced test case. How to Get in Touch GitHub Issues: Create a ticket with the specific tag: [question] ; [feature request]; [suggestion] ; [discussion] -Identity.com website contact form +Civic website contact form # Proposing a Change If you intend to change the public API, or make any non-trivial changes to the implementation, we recommend filing an issue. This lets us reach an agreement on your proposal before you put significant effort into it. @@ -37,7 +37,7 @@ If you decide to fix an issue, please be sure to check the comment thread in cas If somebody claims an issue but doesn’t follow up for more than two weeks, it’s fine to take it over but you should still leave a comment. # Sending a Pull Request -The Identity.com team is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation. +The Civic team is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation. Before submitting a pull request, please make sure the following is done: Fork the repository and create your branch from master. Run `npm install` in the repository root. @@ -47,7 +47,7 @@ Format your code with eslint (`npm run lint`). If you haven’t already, complete the CLA. # Contributor License Agreement (CLA) -By contributing to Identity.com projects, you agree that your contributions will be licensed under its MIT license. +By contributing to Civic projects, you agree that your contributions will be licensed under its MIT license. Contribution Prerequisites # Prerequisites @@ -62,4 +62,4 @@ Then, our linter will catch most issues that may exist in your code. However, there are still some styles that the linter cannot pick up. If you are unsure about something, looking at Airbnb’s Style Guide will guide you in the right direction. # License -By contributing to Identity.com projects, you agree that your contributions will be licensed under its MIT license. +By contributing to Civic projects, you agree that your contributions will be licensed under its MIT license. diff --git a/README.md b/README.md index 09a39d873..1a1e6bf68 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # On-chain Identity Gateway -Welcome to the Identity.com On-chain Identity Gateway monorepo. +Welcome to the Civic On-chain Identity Gateway monorepo. This repository contains libraries that help a smart contract or program on the Blockchain with regulations @@ -38,11 +38,11 @@ Inside each chain's directory (e.g. solana/) are the following libraries: | Directory | Description | Published at | |------------------ |--------------------------------------------------------------------------------------------------------- |-----------------------------------------------------------------------------------| -| http-client | Used by dApp developers to discover and use gateway tokens and to interact with gatekeepers | [npm](https://www.npmjs.com/package/@identity.com/solana-gateway-http-client) | -| gateway-ts | Wrapper library for the blockchain smart-contract or program | [npm](https://www.npmjs.com/package/@identity.com/solana-gateway-ts) | +| http-client | Used by dApp developers to discover and use gateway tokens and to interact with gatekeepers | [npm](https://www.npmjs.com/package/@civic/solana-gateway-http-client) | +| gateway-ts | Wrapper library for the blockchain smart-contract or program | [npm](https://www.npmjs.com/package/@civic/solana-gateway-ts) | | integration-lib | Used by on-chain program or smart-contract developers to restrict the contract to authorised users only | | | program | The source-code for the gateway program or smart-contract | | -| gatekeeper-lib | Used by gatekeepers to allow them to issue gateway tokens on the chain. | [npm](https://www.npmjs.com/package/@identity.com/solana-gatekeeper-lib) | +| gatekeeper-lib | Used by gatekeepers to allow them to issue gateway tokens on the chain. | [npm](https://www.npmjs.com/package/@civic/solana-gatekeeper-lib) | ## Integration diff --git a/ethereum/README.md b/ethereum/README.md index c68f06eb4..813e39974 100644 --- a/ethereum/README.md +++ b/ethereum/README.md @@ -17,7 +17,7 @@ ## Summary -This document describes the Ethereum Virtual Machine (EVM) implementation of the Identity.com Gateway Protocol. +This document describes the Ethereum Virtual Machine (EVM) implementation of the Civic Gateway Protocol. The Gateway Protocol is a standard that allows smart contracts to add access control constraints, requiring that a user has a valid Gateway Token (GT) in order to interact with the smart contract. @@ -190,7 +190,7 @@ Of the upgradeability standards available, the EIP-1822 (UUPS) standard was chos and has been added to the OpenZeppelin SDK, which is used by the protocol. - It is gas-efficient in comparison to some other standards -The upgrade key (the key used to upgrade the protocol) is set to an Identity.com key on deployment. It can be rotated by a +The upgrade key (the key used to upgrade the protocol) is set to an Civic key on deployment. It can be rotated by a superadmin. The superadmin can also disable upgradeability. ## Additional Features @@ -213,9 +213,9 @@ without needing to create a new token type for each combination - it allows clients to accept tokens from multiple gatekeeper networks, if those tokens share common properties. -The flag namespace is managed by Identity.com. Gatekeepers can set and unset flags on their tokens at any time. +The flag namespace is managed by Civic. Gatekeepers can set and unset flags on their tokens at any time. -To request a new flag be added to the namespace, please contact identity.com via [www.identity.com](www.identity.com). +To request a new flag be added to the namespace, please contact civic via [www.civic.com](www.civic.com). ## Glossary diff --git a/ethereum/gatekeeper-cli/README.md b/ethereum/gatekeeper-cli/README.md index b28efb1c0..efc5d43c6 100644 --- a/ethereum/gatekeeper-cli/README.md +++ b/ethereum/gatekeeper-cli/README.md @@ -3,7 +3,7 @@ Gateway ETH CLI CLI for the Gateway Protocol on EVM chains. -For more detail, see the [Gateway Protocol](https://github.com/identity-com/on-chain-identity-gateway) +For more detail, see the [Gateway Protocol](https://github.com/civicteam/on-chain-identity-gateway) [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) [![Version](https://img.shields.io/npm/v/oclif-hello-world.svg)](https://npmjs.org/package/oclif-hello-world) @@ -20,7 +20,7 @@ For more detail, see the [Gateway Protocol](https://github.com/identity-com/on-c # Quick Start ```shell -yarn global add @identity.com/gateway-eth-cli +yarn global add @civic/gateway-eth-cli ``` TIP: run `gateway-eth -h` to see all options at any time. @@ -65,7 +65,7 @@ gateway-eth listen To create a gatekeeper network, find an unused ID, and register it with a name. -NOTE: Consult with identity.com about listing the gatekeeper network, in order to avoid collisions. +NOTE: Consult with civic about listing the gatekeeper network, in order to avoid collisions. ```shell gateway-eth create-gatekeeper-network -c sepolia @@ -74,11 +74,11 @@ gateway-eth create-gatekeeper-network -c sepolia # Usage ```sh-session -$ npm install -g @identity.com/gateway-eth-cli +$ npm install -g @civic/gateway-eth-cli $ gateway-eth COMMAND running command... -$ gateway-eth (-v|--version|version) -@identity.com/gateway-eth-cli/0.2.3 darwin-x64 node-v20.12.0 +$ gateway-eth (--version) +@civic/gateway-eth-cli/0.2.3 darwin-arm64 node-v20.13.1 $ gateway-eth --help [COMMAND] USAGE $ gateway-eth COMMAND @@ -104,6 +104,7 @@ USAGE * [`gateway-eth rename-gatekeeper-network ID NAME`](#gateway-eth-rename-gatekeeper-network-id-name) * [`gateway-eth revoke ADDRESS`](#gateway-eth-revoke-address) * [`gateway-eth unfreeze ADDRESS`](#gateway-eth-unfreeze-address) +* [`gateway-eth verify ADDRESS`](#gateway-eth-verify-address) ## `gateway-eth add-gatekeeper ADDRESS` @@ -111,45 +112,53 @@ Add a gatekeeper to a gatekeeper network ``` USAGE - $ gateway-eth add-gatekeeper ADDRESS + $ gateway-eth add-gatekeeper [ADDRESS] [-h] [-p ] [-t ] [-n ] [-c + localhost|ethereum|sepolia|polygonAmoy|polygon|auroraTestnet|aurora|optimismSepolia|optimism|palmTestnet|palm|arbitr + umSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starknet|starknetGoerli|xdc|xdcApothem|bsc + |cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygonZkEVM|baseSepolia|base] [-f + ] [-g ] [-w ] ARGUMENTS ADDRESS Gatekeeper address to add to the gatekeeper network -OPTIONS - -c, --chain=localhost|ethereum|sepolia|polygonAmoy|polygon|auroraTestnet|aurora|optimismSepolia|optimism|palmTestnet|p - alm|arbitrumSepolia|arbitrum|celo|celoAlfajores|avalancheCChain|avalancheCChainFuji|starknet|starknetGoerli|xdc|xdcApo - them|bsc|cronos|fantom|fantomTestnet|gnosis|moonbeam|moonriver|polygonZkEVMTestnet|polygonZkEVM|baseSepolia|base +FLAGS + -c, --chain=