-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
updated module path, adding licence, adding ci
- Loading branch information
1 parent
43824af
commit 9f9cd90
Showing
17 changed files
with
269 additions
and
166 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| name: Build Rarimo TSS service docker image | ||
| on: | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| converge: | ||
| name: Converge | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
|
|
||
| - name: Checkout code | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Install werf | ||
| uses: werf/actions/[email protected] | ||
|
|
||
| - name: Log in to registry | ||
| # This is where you will update the personal access token to GITHUB_TOKEN | ||
| run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u $ --password-stdin | ||
|
|
||
| - name: Run echo | ||
| run: | | ||
| werf version | ||
| docker version | ||
| echo $GITHUB_REPOSITORY | ||
| echo $GITHUB_SHA | ||
| - name: Run Build | ||
| run: | | ||
| . $(werf ci-env github --as-file) | ||
| werf export service --tag ghcr.io/$GITHUB_REPOSITORY:$GITHUB_SHA |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| name: Build Rarimo TSS service docker image | ||
| on: | ||
| push: | ||
| branches: | ||
| - 'main' | ||
| - 'master' | ||
| - 'chains/mainnet' | ||
| - 'chains/mainnet-beta' | ||
|
|
||
| jobs: | ||
| converge: | ||
| name: Converge | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
|
|
||
| - name: Checkout code | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Install werf | ||
| uses: werf/actions/[email protected] | ||
|
|
||
| - name: Log in to registry | ||
| # This is where you will update the personal access token to GITHUB_TOKEN | ||
| run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u $ --password-stdin | ||
|
|
||
| - name: Run echo | ||
| run: | | ||
| werf version | ||
| docker version | ||
| echo $GITHUB_REPOSITORY | ||
| echo $GITHUB_SHA | ||
| - name: Run Build | ||
| run: | | ||
| . $(werf ci-env github --as-file) | ||
| werf export service --tag ghcr.io/$GITHUB_REPOSITORY:$GITHUB_SHA |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| name: Build Rarimo TSS service docker image tag | ||
| on: | ||
| push: | ||
| tags: | ||
| - 'v[0-9]+.[0-9]+.[0-9]+' | ||
|
|
||
| jobs: | ||
| converge: | ||
| name: Converge | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
|
|
||
| - name: Checkout code | ||
| uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - name: Install werf | ||
| uses: werf/actions/[email protected] | ||
|
|
||
| - name: Log in to registry | ||
| # This is where you will update the personal access token to GITHUB_TOKEN | ||
| run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u $ --password-stdin | ||
|
|
||
| - name: Run echo | ||
| run: | | ||
| werf version | ||
| docker version | ||
| echo $GITHUB_REPOSITORY | ||
| echo $GITHUB_REF_NAME | ||
| - name: Run Build | ||
| run: | | ||
| . $(werf ci-env github --as-file) | ||
| werf export service --tag ghcr.io/$GITHUB_REPOSITORY:$GITHUB_REF_NAME |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| Copyright 2023 Zero Block Global Foundation | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,92 +1,75 @@ | ||
| # evm-identity-saver-svc | ||
|
|
||
| [](https://opensource.org/licenses/MIT) | ||
|
|
||
| Decentralized Oracle service to observe Iden3 state smart contract events and submit them to Rarimo core. | ||
|
|
||
| ## Getting started | ||
| ## Configuration | ||
| The following configuration .yaml file should be provided to launch your oracle: | ||
|
|
||
| To make it easy for you to get started with GitLab, here's a list of recommended next steps. | ||
| ```yaml | ||
| log: | ||
| disable_sentry: true | ||
| level: debug | ||
|
|
||
| Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)! | ||
| ## Port to listen incoming requests (used to trigger revote for some operation - rare flow) | ||
| listener: | ||
| addr: :8000 | ||
|
|
||
| ## Add your files | ||
| evm: | ||
| ## State contract for listening | ||
| contract_addr: "" | ||
| ## Websocket address | ||
| rpc: "" | ||
| ## Start block to listen events. (0 - listen from current). Used to catchup old events. Be careful to use. | ||
| start_from_block: | ||
| ## According to network name in Rarimo core. Example: Polygon | ||
| network_name: | ||
| ## How many blocks should be created after event to fetch it. | ||
| block_window: | ||
|
|
||
| - [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files | ||
| - [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command: | ||
| broadcaster: | ||
| ## address of broadcaster-svc | ||
| addr: "" | ||
| ## sender account address (rarimo..) | ||
| sender_account: "" | ||
|
|
||
| ``` | ||
| cd existing_repo | ||
| git remote add origin https://gitlab.com/rarimo/evm-identity-saver-svc.git | ||
| git branch -M main | ||
| git push -uf origin main | ||
| ``` | ||
|
|
||
| ## Integrate with your tools | ||
|
|
||
| - [ ] [Set up project integrations](https://gitlab.com/rarimo/evm-identity-saver-svc/-/settings/integrations) | ||
|
|
||
| ## Collaborate with your team | ||
|
|
||
| - [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) | ||
| - [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) | ||
| - [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically) | ||
| - [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/) | ||
| - [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) | ||
|
|
||
| ## Test and Deploy | ||
|
|
||
| Use the built-in continuous integration in GitLab. | ||
|
|
||
| - [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) | ||
| - [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/) | ||
| - [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html) | ||
| - [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/) | ||
| - [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html) | ||
|
|
||
| *** | ||
| ## Rarimo chain connections | ||
|
|
||
| # Editing this README | ||
| core: | ||
| addr: tcp://validator:26657 | ||
|
|
||
| When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template. | ||
| cosmos: | ||
| addr: validator:9090 | ||
|
|
||
| ## Suggestions for a good README | ||
| Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information. | ||
| ## Profiling | ||
|
|
||
| ## Name | ||
| Choose a self-explaining name for your project. | ||
| profiler: | ||
| enabled: false | ||
| addr: :8080 | ||
|
|
||
| ## Description | ||
| Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors. | ||
| ## Issuer information | ||
|
|
||
| ## Badges | ||
| On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge. | ||
|
|
||
| ## Visuals | ||
| Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method. | ||
|
|
||
| ## Installation | ||
| Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection. | ||
|
|
||
| ## Usage | ||
| Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README. | ||
|
|
||
| ## Support | ||
| Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc. | ||
|
|
||
| ## Roadmap | ||
| If you have ideas for releases in the future, it is a good idea to list them in the README. | ||
|
|
||
| ## Contributing | ||
| State if you are open to contributions and what your requirements are for accepting them. | ||
| state_contract_cfg: | ||
| issuer_id: ['', ''] | ||
| disable_filtration: true | ||
| ``` | ||
|
|
||
| For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self. | ||
| You will also need some environment variables to run: | ||
|
|
||
| You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser. | ||
| ```yaml | ||
| - name: KV_VIPER_FILE | ||
| value: /config/config.yaml # The path to your config file | ||
| ``` | ||
|
|
||
| ## Authors and acknowledgment | ||
| Show your appreciation to those who have contributed to the project. | ||
|
|
||
| ## License | ||
| For open source projects, say how it is licensed. | ||
| ## Run | ||
| To start the service (in vote mode) use the following command: | ||
| ```shell | ||
| evm-identity-saver-svc run state-update-voter | ||
| ``` | ||
|
|
||
| ## Project status | ||
| If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers. | ||
| To run in full mode: | ||
| ```shell | ||
| evm-identity-saver-svc run state-update-all | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.