{"id":18437859,"url":"https://github.com/zilliqa/multisig-wallet-generator","last_synced_at":"2025-06-25T03:05:43.002Z","repository":{"id":43043726,"uuid":"451354128","full_name":"Zilliqa/multisig-wallet-generator","owner":"Zilliqa","description":"Zilliqa Multisig Wallet Generator","archived":false,"fork":false,"pushed_at":"2022-03-22T06:32:19.000Z","size":268,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-06-25T03:05:42.783Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Zilliqa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-01-24T07:10:19.000Z","updated_at":"2023-10-02T05:43:33.000Z","dependencies_parsed_at":"2022-09-18T12:10:25.174Z","dependency_job_id":null,"html_url":"https://github.com/Zilliqa/multisig-wallet-generator","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Zilliqa/multisig-wallet-generator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fmultisig-wallet-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fmultisig-wallet-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fmultisig-wallet-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fmultisig-wallet-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Zilliqa","download_url":"https://codeload.github.com/Zilliqa/multisig-wallet-generator/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zilliqa%2Fmultisig-wallet-generator/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261795319,"owners_count":23210619,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T06:16:29.119Z","updated_at":"2025-06-25T03:05:42.971Z","avatar_url":"https://github.com/Zilliqa.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ch1\u003e\n  Zilliqa Multi-Sig Wallet Generator\n  \u003c/h1\u003e\n  \u003cstrong\u003e\n  Generates a multi-sig wallet contract for your use case\n  \u003c/strong\u003e\n\u003c/div\u003e\n\u003chr/\u003e\n\u003cdiv\u003e\n  \u003ca href=\"https://app.travis-ci.com/Zilliqa/multisig-wallet-generator\" target=\"_blank\"\u003e\n  \u003cimg src=\"https://app.travis-ci.com/Zilliqa/multisig-wallet-generator.svg?token=6BrmjBEqdaGp73khUJCz\u0026branch=main\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"LICENSE\" target=\"_blank\"\u003e\n  \u003cimg src=\"https://img.shields.io/badge/License-GPLv3-blue.svg\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n## Prerequisites\n\n- [Docker](https://www.docker.com)\n- [Node.js](https://nodejs.org/en/)\n\n## Installation\n\n### `npm i`\n\nInstalls the dependencies.\n\n## Usage\n\n### Step 1. Annotate your transitions: `(* @multi-sig *)`\n\ne.g.\n\nfoo.scilla\n\n```ocaml\n(* @multi-sig *)\n(* Pauses the contract. Use this when things are going wrong ('circuit breaker'). *)\ntransition Pause()\n  RequireNotPaused;\n  RequireContractOwner;\n\n  is_paused := true;\n  e = {\n    _eventname: \"Pause\";\n    is_paused: true\n  };\n  event e\nend\n\n```\n\n### Step 2. Put your contracts in `input/`\n\ne.g.\n\n```\ninput/foo.scilla\ninput/bar.scilla\ninput/baz.scilla\n```\n\n### Step 3. Run `npm run gen`\n\nGenerates your multi-sig wallet contract: `output/msw.scilla` by default.\n\nDuring the contract generation, it makes API calls to `https://scilla-server.zilliqa.com/contract/check`.\n\nTo avoid this behavior, run `npm run gen:docker`. It uses [Isolated Server container](https://hub.docker.com/r/zilliqa/zilliqa-isolated-server) instead.\n\n## Environment Variables\n\n| Name          | Description                                                          | Default Value |\n| ------------- | -------------------------------------------------------------------- | ------------- |\n| `INPUT_DIR`   | A folder for the input contract with `(* @multi-sig *)` annotations. | `input/`      |\n| `OUTPUT_DIR`  | A folder for the generated multi-sig wallet contract.                | `output/`     |\n| `PORT`        | The port of Isolated Server container.                               | `5555`        |\n| `CONTAINER`   | The name of Isolated Server container.                               |               |\n| `CHECKER_URL` | The URL of Scilla Checker API.                                       |               |\n\n## Contract Testing\n\n### `npm test`\n\nRuns contract tests using [Isolated Server container](https://hub.docker.com/r/zilliqa/zilliqa-isolated-server), [Jest](https://jestjs.io/), and [Scilla JSON Utils](https://github.com/Zilliqa/scilla-json-utils)\n\n## Constructing the parameters of `SubmitCustomTransaction`\n\nMultiSigTransition ADT\n\n```ocaml\ntype MultiSigTransition =\n  | Allow of (List (ByStr20))\n  | Disallow of (List (ByStr20))\n```\n\nExample parameters\n\n```json\n[\n  {\n    \"type\": \"ByStr20\",\n    \"value\": \"0x0c4769cddb5e54683126c33b116c5ff9765c2ac3\",\n    \"vname\": \"contract_address\"\n  },\n  {\n    \"type\": \"0xf6241e9d6b033847e814e6cc7022fa1360fe4fe3.MultiSigTransition\",\n    \"value\": {\n      \"argtypes\": [],\n      \"arguments\": [\n        [\n          \"0x268fb34ad21aa21b02ff9ad77f29d2f08dabeb93\",\n          \"0xa3755a10dba7bbe77770c620041b442c624be0a1\"\n        ]\n      ],\n      \"constructor\": \"0xf6241e9d6b033847e814e6cc7022fa1360fe4fe3.Allow\"\n    },\n    \"vname\": \"transaction\"\n  }\n]\n```\n\n_Consider using [Scilla JSON Utils](https://github.com/Zilliqa/scilla-json-utils) to construct the above JSON values._\n\n## License\n\nThis project is open source software licensed as [GPL-3.0](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzilliqa%2Fmultisig-wallet-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzilliqa%2Fmultisig-wallet-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzilliqa%2Fmultisig-wallet-generator/lists"}