@massalabs/multisig-contract 0.1.1-dev.20260420091552 → 0.1.1-dev.20260506131730

package/README.md

@@ -1,169 +1,286 @@
-# Massa Multisignature Wallet
-
-The purpose of multisig wallets is to increase security by requiring multiple parties to agree on transactions before execution. Transactions can be executed only when confirmed by a predefined number of owners.
-
-Features
-Can hold Massa and all kinds of tokens
-Integration with web3 wallets 
-Interacting with any contracts
- @dev Most important concepts:
- *      Threshold/required: Number of required confirmations for a Multisig transaction.
- *      Owners: List of addresses that control the Multisig. They are the only ones that
-        can submit, approve, and execute transactions.
- *      UpgradeDelay: Delay necessary between an upgrade proposition and the actual upgrade
- *      executionDelay: Delay necessary between the time the threshold is met for a specific transaction and its execution.
- *      Id: Each transaction has a different ID to prevent replay attacks.
- *      Signature: A valid signature of an owner of the Multisig for a transaction hash.
- *      Owners can only be added/removed by the multisig (same for changing the threshold
-        and upgrading the contract)
- *      Change the owners, required,& upgradeDelay to your needs in src/deploy.ts 
-
-The executionDelay starts once the threshold is met, and is not reset when another wallet approves the tx. It can be reset if a wallet revokes approval and the approval count goes below the threshold.
-
-Anyone can send coins to the multisig using the receiveCoins functions.
-Only owners can call submit, approve, execute & revoke functions.
-Only the multisig itself can call addOwner, removeOwner, replaceOwner, changeRequirement, changeExecutionDelay, changeUpgradeDelay, proposeUpgrade & upgrade functions. Thus, they can only be called by submitting the call through the multisig, approving & executing it.
-
-## Security
-
-The code was fully audited for security by a third party professional security firm.
-The report is publicly available as the [security_audit.pdf](security_audit.pdf) file at the root of the repository.
-
-## Build
-
-By default this will build all files in `assembly/contracts` directory.
-
-```shell
-npm run build
-```
-
-## Deploy the multisig
-
-Prerequisites :
-
-- You must add a `.env` file at the root of the repository with the following keys set to valid values:
-- `PRIVATE_KEY="wallet_private_key"`
-- `RPC_URL="https://..."` (optional, defaults to buildnet)
-
-These keys will be the ones used by the deployment script to interact with the blockchain.
-
-Adapt `required`, `owners` & `upgradeDelay` to your liking (cf. important concepts) in `src/deploy.ts`.
-
-The following command will build contracts in `assembly/contracts` directory and execute the deployment script
-`src/deploy.ts`. This script deploys `Multisig.wasm` directly and automatically runs its constructor.
-
-```shell
-npm run deploy
-```
-
-## Proposal lifecycle (important)
-
-Submitting a proposal does **not** count as an approval for the proposing owner. The proposer must call approve separately if they want their confirmation included toward the threshold.
-
-The approve flow only records confirmations. When the number of approvals reaches the threshold, the proposal is **not** executed automatically. Someone with the right to execute must call execute explicitly (and respect any `executionDelay` enforced on-chain after the threshold is met).
-
-These behaviors are intentional in the current design. Automatically approving on behalf of the submitter, or automatically executing once the threshold is reached, could be explored as future improvements but are not implemented today.
-
-## Create an add-member proposal
-
-The repository also includes a helper script to submit a multisig proposal that adds a new owner.
-
-```shell
-npm run propose:add-member -- <multisig-address> <new-member-address>
-```
-
-The script uses the same `.env` configuration as deployment and prints the submitted operation id plus the final events emitted by the contract.
-
-## Create a revoke-member proposal
-
-The repository also includes a helper script to submit a multisig proposal that removes an existing owner.
-
-```shell
-npm run propose:revoke-member -- <multisig-address> <member-address>
-```
-
-The script uses the same `.env` configuration as deployment and prints the submitted operation id plus the final events emitted by the contract.
-
-## Create a replace-member proposal
-
-The repository also includes a helper script to submit a multisig proposal that replaces an existing owner with a new one.
-
-```shell
-npm run propose:replace-member -- <multisig-address> <current-member-address> <new-member-address>
-```
-
-The script uses the same `.env` configuration as deployment and prints the submitted operation id plus the final events emitted by the contract.
-
-## Create a threshold proposal
-
-The repository also includes a helper script to submit a multisig proposal that updates the required approval threshold.
-
-```shell
-npm run propose:threshold -- <multisig-address> <threshold>
-```
-
-The script uses the same `.env` configuration as deployment and prints the submitted operation id plus the final events emitted by the contract.
-
-## Create an execution-delay proposal
-
-The repository also includes a helper script to submit a multisig proposal that updates the execution delay.
-
-```shell
-npm run propose:execution-delay -- <multisig-address> <execution-delay>
-```
-
-The script uses the same `.env` configuration as deployment and prints the submitted operation id plus the final events emitted by the contract.
-
-## Approve a proposal
-
-The repository also includes a helper script to approve an existing multisig proposal by id.
-
-```shell
-npm run approve:proposal -- <multisig-address> <proposal-id>
-```
-
-The script uses the same `.env` configuration as deployment and prints the approval operation id plus the final events emitted by the contract.
-
-## Execute a proposal
-
-The repository also includes a helper script to execute an existing multisig proposal by id.
-
-```shell
-npm run execute:proposal -- <multisig-address> <proposal-id>
-```
-
-The script uses the same `.env` configuration as deployment and prints the execution operation id plus the final events emitted by the contract.
-
-## List proposals
-
-The repository also includes a read-only helper script to retrieve all multisig proposals and their current statuses.
-
-```shell
-npm run list:proposals -- <multisig-address>
-```
-
-The script prints a JSON array with each proposal's id, target, method, value, approvals, timestamp, execution flag, and derived status.
-
-## Get multisig parameters
-
-The repository also includes a read-only helper script to retrieve the multisig members, threshold, and execution delay directly from storage.
-
-```shell
-npm run get:multisig-parameters -- <multisig-address>
-```
-
-The script prints a JSON object containing the `members`, `threshold`, and `delay`.
-
-## Unit tests
-
-The test framework documentation is available here: [as-pect docs](https://as-pect.gitbook.io/as-pect)
-
-```shell
-npm run test
-```
-
-## Format code
-
-```shell
-npm run fmt
-```
+# Massa Multisignature Wallet
+
+The purpose of multisig wallets is to increase security by requiring multiple parties to agree on transactions before execution. Transactions can be executed only when confirmed by a predefined number of owners.
+
+Features
+Can hold Massa and all kinds of tokens
+Integration with web3 wallets 
+Interacting with any contracts
+ @dev Most important concepts:
+ *      Threshold/required: Number of required confirmations for a Multisig transaction.
+ *      Owners: List of addresses that control the Multisig. They are the only ones that
+        can submit, approve, and execute transactions.
+ *      UpgradeDelay: Delay necessary between an upgrade proposition and the actual upgrade
+ *      executionDelay: Delay necessary between the time the threshold is met for a specific transaction and its execution.
+ *      Id: Each transaction has a different ID to prevent replay attacks.
+ *      Signature: A valid signature of an owner of the Multisig for a transaction hash.
+ *      Owners can only be added/removed by the multisig (same for changing the threshold
+        and upgrading the contract)
+ *      Change the owners, required,& upgradeDelay to your needs in src/deploy.ts 
+
+The executionDelay starts once the threshold is met, and is not reset when another wallet approves the tx. It can be reset if a wallet revokes approval and the approval count goes below the threshold.
+
+Anyone can send coins to the multisig using the receiveCoins functions.
+Only owners can call submit, approve, execute & revoke functions.
+Only the multisig itself can call addOwner, removeOwner, replaceOwner, changeRequirement, changeExecutionDelay, changeUpgradeDelay, proposeUpgrade & upgrade functions. Thus, they can only be called by submitting the call through the multisig, approving & executing it.
+
+## Security
+
+The code was fully audited for security by a third party professional security firm.
+The report is publicly available as the [security_audit.pdf](security_audit.pdf) file at the root of the repository.
+
+## Build
+
+By default this will build all files in `assembly/contracts` directory.
+
+```shell
+npm run build
+```
+
+## Deploy the multisig
+
+Prerequisites :
+
+- You must add a `.env` file at the root of the repository with the following keys set to valid values:
+- `PRIVATE_KEY="wallet_private_key"`
+- `C_LAYER_RPC_URL="https://..."` (optional, defaults to buildnet)
+- `CURRENCY_REGISTRY_ADDRESS="AS..."` (required for currency-registry helper scripts)
+
+These keys will be the ones used by the deployment script to interact with the blockchain.
+
+Adapt `required`, `owners` & `upgradeDelay` to your liking (cf. important concepts) in `src/deploy.ts`.
+
+The following command will build contracts in `assembly/contracts` directory and execute the deployment script
+`src/deploy.ts`. This script deploys `Multisig.wasm` directly and automatically runs its constructor.
+
+```shell
+npm run deploy
+```
+
+## Generate a wallet
+
+You can generate a new Massa wallet keypair for local usage with:
+
+```shell
+npm run generate:wallet
+```
+
+The script prints the wallet address and a `PRIVATE_KEY="..."` line you can copy into your `.env`.
+
+## Proposal lifecycle (important)
+
+Submitting a proposal does **not** count as an approval for the proposing owner. The proposer must call approve separately if they want their confirmation included toward the threshold.
+
+The approve flow only records confirmations. When the number of approvals reaches the threshold, the proposal is **not** executed automatically. Someone with the right to execute must call execute explicitly (and respect any `executionDelay` enforced on-chain after the threshold is met).
+
+These behaviors are intentional in the current design. Automatically approving on behalf of the submitter, or automatically executing once the threshold is reached, could be explored as future improvements but are not implemented today.
+
+## Create an add-member proposal
+
+The repository also includes a helper script to submit a multisig proposal that adds a new owner.
+
+```shell
+npm run propose:add-member -- <multisig-address> <new-member-address>
+```
+
+The script uses the same `.env` configuration as deployment and prints the submitted operation id plus the final events emitted by the contract.
+
+## Create a revoke-member proposal
+
+The repository also includes a helper script to submit a multisig proposal that removes an existing owner.
+
+```shell
+npm run propose:revoke-member -- <multisig-address> <member-address>
+```
+
+The script uses the same `.env` configuration as deployment and prints the submitted operation id plus the final events emitted by the contract.
+
+## Create a replace-member proposal
+
+The repository also includes a helper script to submit a multisig proposal that replaces an existing owner with a new one.
+
+```shell
+npm run propose:replace-member -- <multisig-address> <current-member-address> <new-member-address>
+```
+
+The script uses the same `.env` configuration as deployment and prints the submitted operation id plus the final events emitted by the contract.
+
+## Create a threshold proposal
+
+The repository also includes a helper script to submit a multisig proposal that updates the required approval threshold.
+
+```shell
+npm run propose:threshold -- <multisig-address> <threshold>
+```
+
+The script uses the same `.env` configuration as deployment and prints the submitted operation id plus the final events emitted by the contract.
+
+## Create an execution-delay proposal
+
+The repository also includes a helper script to submit a multisig proposal that updates the execution delay.
+
+```shell
+npm run propose:execution-delay -- <multisig-address> <execution-delay>
+```
+
+The script uses the same `.env` configuration as deployment and prints the submitted operation id plus the final events emitted by the contract.
+
+## Create a currency pause/unpause proposal (C-layer)
+
+The repository also includes a helper script to submit a multisig proposal that updates `isPaused` for a currency in the C-layer currency-registry.
+
+```shell
+npm run propose:currency-pause -- <multisig-address> <currency-ticker> <pause|unpause>
+```
+
+The script reads the current currency from currency-registry, preserves all fields, toggles only `isPaused`, then submits a multisig `updateCurrency` proposal with the same coin value used by the currency-registry wrapper (`0.1 MAS`).
+
+## Add a currency to registry (C-layer)
+
+The repository also includes a helper script to call `createCurrency` on the C-layer currency-registry.
+
+```shell
+npm run add:currency-to-registry -- <ticker> <name> <decimals> <currency-multisig-address> [isPaused]
+```
+
+Notes:
+* This call requires a wallet with the `CURRENCY_MANAGER` role (typically the COS-managed key).
+* The script uses `PRIVATE_KEY` from `.env` as the caller key.
+* It submits with `0.1 MAS`, aligned with the `certonym-contracts` currency-registry wrapper.
+* `isPaused` is optional (`false` by default). Accepted values: `true/false` or `1/0`.
+
+## Remove a currency from registry (C-layer)
+
+The repository also includes a helper script to call `removeCurrency` on the C-layer currency-registry.
+
+```shell
+npm run remove:currency-from-registry -- <currency-id>
+```
+
+## Create a mint proposal (P-layer)
+
+The repository also includes a helper script to submit a P-layer multisig `mint` proposal via the Player API.
+
+```shell
+npm run propose:mint -- <decc-no> <amount> <currency-ticker>
+```
+
+For P-layer scripts, `<amount>` is a user amount using currency decimals
+(for decimals=2, `10` means a raw amount of `1000`).
+
+## Create a transfer_from proposal (P-layer)
+
+The repository also includes a helper script to submit a P-layer multisig `transfer_from` proposal via the Player API.
+
+```shell
+npm run propose:transfer_from -- <multisig-decc-no> <sender-decc-no> <recipient-decc-no> <amount> <currency-ticker>
+```
+
+## Create a freeze_account proposal (P-layer)
+
+The repository also includes a helper script to submit a P-layer multisig `freeze_account` proposal via the Player API.
+
+```shell
+npm run propose:freeze_account -- <multisig-decc-no> <target-decc-no> <currency-ticker>
+```
+
+## Create an unfreeze_account proposal (P-layer)
+
+The repository also includes a helper script to submit a P-layer multisig `unfreeze_account` proposal via the Player API.
+
+```shell
+npm run propose:unfreeze_account -- <multisig-decc-no> <target-decc-no> <currency-ticker>
+```
+
+## List proposals (P-layer)
+
+The repository also includes a read-only helper script to retrieve non-executed P-layer multisig proposals for a currency.
+
+```shell
+npm run list:p-layer-proposals -- <multisig-decc-no> <currency-ticker>
+```
+
+The script prints a JSON array with proposal ids, proposal type data, approval count, status, and period metadata.
+
+## Approve a proposal (P-layer)
+
+The repository also includes a helper script to approve an existing P-layer multisig proposal by id.
+
+```shell
+npm run approve:p-layer-proposal -- <multisig-decc-no> <currency-ticker> <proposal-id>
+```
+
+## Get available currency info (P-layer)
+
+```shell
+npm run get:available-currency-info
+```
+
+This script prints currencies in the form `TICKER: Name. Decimals: X. ID: Y. Paused: Z`.
+
+## Get currency multisig info (P-layer)
+
+```shell
+npm run get:currency-multisig-info -- <currency-ticker>
+```
+
+The script submits the approval via the Player API and prints the resulting operation id.
+
+These scripts use:
+- `PRIVATE_KEY` from `.env` for signing,
+- `P_LAYER_GRPC_URL` from `.env` for gRPC endpoint,
+- proposal kind encoding from `p-layer-runtime/api/example-js`.
+
+## Approve a proposal
+
+The repository also includes a helper script to approve an existing multisig proposal by id.
+
+```shell
+npm run approve:proposal -- <multisig-address> <proposal-id>
+```
+
+The script uses the same `.env` configuration as deployment and prints the approval operation id plus the final events emitted by the contract.
+
+## Execute a proposal
+
+The repository also includes a helper script to execute an existing multisig proposal by id.
+
+```shell
+npm run execute:proposal -- <multisig-address> <proposal-id>
+```
+
+The script uses the same `.env` configuration as deployment and prints the execution operation id plus the final events emitted by the contract.
+
+## List proposals
+
+The repository also includes a read-only helper script to retrieve all multisig proposals and their current statuses.
+
+```shell
+npm run list:proposals -- <multisig-address>
+```
+
+The script prints a JSON array with each proposal's id, target, method, value, approvals, timestamp, execution flag, and derived status.
+
+## Get multisig parameters
+
+The repository also includes a read-only helper script to retrieve the multisig members, threshold, and execution delay directly from storage.
+
+```shell
+npm run get:multisig-parameters -- <multisig-address>
+```
+
+The script prints a JSON object containing the `members`, `threshold`, and `delay`.
+
+## Unit tests
+
+The test framework documentation is available here: [as-pect docs](https://as-pect.gitbook.io/as-pect)
+
+```shell
+npm run test
+```
+
+## Format code
+
+```shell
+npm run fmt
+```

package/package.json

@@ -1,20 +1,32 @@
 {
     "name": "@massalabs/multisig-contract",
-    "version": "0.1.1-dev.20260420091552",
+    "version": "0.1.1-dev.20260506131730",
     "description": "",
     "scripts": {
         "test": "asp --summary",
         "build": "npx massa-as-compile",
         "deploy": "tsx src/deploy.ts",
+        "generate:wallet": "tsx src/generate-wallet.ts",
+        "add:currency-to-registry": "tsx src/add-currency-to-registry.ts",
+        "remove:currency-from-registry": "tsx src/remove-currency-from-registry.ts",
         "approve:proposal": "tsx src/approve-proposal.ts",
         "execute:proposal": "tsx src/execute-proposal.ts",
         "get:multisig-parameters": "tsx src/get-multisig-parameters.ts",
         "list:proposals": "tsx src/list-proposals.ts",
+        "list:p-layer-proposals": "tsx src/list-p-layer-proposals.ts",
+        "get:available-currency-info": "tsx src/get-available-currency-info.ts",
+        "get:currency-multisig-info": "tsx src/get-currency-multisig-info.ts",
         "propose:add-member": "tsx src/propose-add-member.ts",
         "propose:replace-member": "tsx src/propose-replace-member.ts",
         "propose:revoke-member": "tsx src/propose-revoke-member.ts",
         "propose:threshold": "tsx src/propose-threshold.ts",
         "propose:execution-delay": "tsx src/propose-execution-delay.ts",
+        "propose:currency-pause": "tsx src/propose-currency-pause.ts",
+        "propose:mint": "tsx src/propose-mint.ts",
+        "propose:transfer_from": "tsx src/propose-transfer-from.ts",
+        "propose:freeze_account": "tsx src/propose-freeze-account.ts",
+        "propose:unfreeze_account": "tsx src/propose-unfreeze-account.ts",
+        "approve:p-layer-proposal": "tsx src/approve-p-layer-proposal.ts",
         "prettier": "prettier assembly//**/*.ts --check",
         "prettier:fix": "prettier assembly//**/*.ts --write",
         "lint": "eslint .",