diff --git a/README.md b/README.md index 9218a5dbfb8fd4c45d6cdfcfb41da5cc5df405b0..93c299639715e009325499aa2ea4a4cd7667e69e 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,103 @@ -# Multi signature +# QSI_Groupe2 -This exeample is meant to illustrate a transaction requiring multiple people's confirmation before the operation is executed. With this MVP example smart-contrat, we show how to use multisig-type confirmation from M of N signers in order to send an operation. In this example, we will bind a call to a token transfer from another smart-contrat, since it’s the most classic use case ( Fungible Asset 2 ). +## Getting started -## The multisig pattern +To make it easy for you to get started with GitLab, here's a list of recommended next steps. -Step Zero : deploy the contract with desired parameters and bind it to the entrypoint to execute. Each time a multisignature is required : +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)! -1. A signer proposes a new operation execution with parameters -2. M of N possible signers submit an approval transaction to the smart-contrat -3. When the last required signer submits their approval transaction and the threshold is obtained, the resulting original transaction of the first signer is executed +## Add your files -Any number of operations can be in valid execution at the same time. +- [ ] [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: -The multisig contract can be invoked to request any operation on other smart contracts. +``` +cd existing_repo +git remote add origin https://gitlab.univ-lille.fr/lydia.tarmelit.etu/qsi_groupe2.git +git branch -M main +git push -uf origin main +``` -## Content +## Integrate with your tools -The `multisig` project contains 2 main directories: +- [ ] [Set up project integrations](https://gitlab.univ-lille.fr/lydia.tarmelit.etu/qsi_groupe2/-/settings/integrations) -- `src`: contains smart contracts implementation in jsligo -- `fa2` - contains implementation of FA2 token used by the multisig contract +## Collaborate with your team -## Pre-requisites +- [ ] [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/) +- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) -You need to install the following tools: +## Test and Deploy -- [NodeJS & Npm](https://nodejs.org/en/download/) -- [LIGO](https://ligolang.org/docs/intro/installation/) **or** [Docker](https://docs.docker.com/get-docker/) +Use the built-in continuous integration in GitLab. -## Compiling / testing / deploying +- [ ] [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) -This repository provides a Makefile for compiling and testing smart contracts. One can type `make` to display all available rules. -The `make all` command will clean all produced smart contracts, then compile smart contracts and then launch tests. +--- -- The `make compile` command triggers the compilation of smart contracts (advisor and indice). +# Editing this README -- The `make test` command launches tests oon compiled smart contracts (advisor and indice). +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!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. -- The `make deploy` command deploys smart contracts. You need to rename `deploy/.env.dist` to `deploy/.env` and **fill the required variables**. +## Suggestions for a good README -You can also override `make` parameters by running : +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. -```sh -make compile ligo_compiler=<LIGO_EXECUTABLE> protocol_opt="--protocol <PROTOCOL>" -``` +## Name + +Choose a self-explaining name for your project. + +## 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. + +## 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. + +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 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. + +## Authors and acknowledgment + +Show your appreciation to those who have contributed to the project. + +## License + +For open source projects, say how it is licensed. + +## 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.