CLI-MSafe

The CLI interface for interacting Momentum Safe. This repository majorly has two components:

1. The CLI interface for users to interact with Momentum Safe.
2. Scripts to interact with the Momentum Safe.
3. The underlying typescript SDK of for smart contract interaction.

1. Installation

Clone the repository and change directory:

git clone git@github.com:Momentum-Safe/CLI-MSafe.git
cd CLI-MSafe

Install dependencies:

yarn install

Install Aptos CLI tools.

The CLI tool is used for setting up the initial account. Install with github release or compile from source.

• Github release (Recommended)
• Install from source

Initialize a wallet

Use aptos CLI to setup the wallet and environment.

aptos init 

Choose all default settings to create a new wallet with the devnet endpoint settings.

The command will create a config file .aptos/config.yaml under the current directory, which includes the wallet information as well as the network endpoint message.

2. Interactive CLI

Start Momentum Safe CLI

yarn start

And follow the instructions to operate with momemtum safe.

Interact with Momentum Safe

Please check Gitbook for handbook of interactive CLI tools.

The following features are currently supported by Momentum Safe:

1. Momentum Safe creation
2. APT coin transfer
3. View momentum safe owned by the account
4. View pending transactions of the momentum safe
5. Coin registry.
6. Coin transfer of any coin type.
7. Custom MOVE module interaction (For simple types).
8. MOVE module publish.
9. Revert transaction.

We will add more features shortly:

1. Add coin decimal and bigint
2. Add more custom ABI, struct, e.t.c.

3. Running script using SDK

Several scripts are provided as example to interact with SDK.

1. scripts/deploy.ts Can be used to deploy a MOVE module with momentum safe.
2. scripts/entry-function.ts An example script to interact with an entry function.
3. scripts/move-script.ts An example script to run move script.

3.1. deploy.ts

deploy.ts is the script used to deploy the move module.

You will need to finish the following items as the prerequisite before calling this script.

1. You have ready have a momentum safe wallet created with the account in config.yaml in step 1.
2. Deployer address is replaced with the momentum safe address in Move.toml
3. MOVE module is compiled with flag --save-metadata

After compiled the move module, call

yarn run deploy --msafe ${MSAFE_ADDRESS} --move-dir ./tests/move

There is some test contracts in folder ./test/move that you may try it out.

Action:			Module publish
Verify Hash:		0x80e3c2779b714ab355ecc6fc4c8db221e770adb127a18ebfb150f11d9ca65edc
Deployer:		0x1908fe0d337d7bd718c8465030c5f306377ac396f3d7acce92f526ae41637cc0
Package:		MomentumSafe-test
Upgrade Policy:		compatible
Upgrade Number:		0
Source Digest:		BC36D67FB3DE5ABD5541BCAF633C28E1EFECF0DDDED20544296DCA98F744DE82
Modules:		0x1908fe0d337d7bd718c8465030c5f306377ac396f3d7acce92f526ae41637cc0::message
			0x1908fe0d337d7bd718c8465030c5f306377ac396f3d7acce92f526ae41637cc0::test_coin
Dependency:		0x0000000000000000000000000000000000000000000000000000000000000001::AptosFramework
			0x0000000000000000000000000000000000000000000000000000000000000001::AptosStdlib
			0x0000000000000000000000000000000000000000000000000000000000000001::MoveStdlib
Sender:			0x1908fe0d337d7bd718c8465030c5f306377ac396f3d7acce92f526ae41637cc0
Sequence Number:	8
Expiration:		Thu Oct 13 2022 18:00:20 GMT-0700 (Pacific Daylight Time)
Gas Price:		100
Max Gas:		5000

--------------------

Do you confirm with the transaction? [Y/n]

The script will load compiled move modules from move directory and print message about the code deployment.

After confirm, the transaction to initiate the multi-sig transaction request will be confirmed on blockchain.

3.2 Call an entry function

Run an entry function using scripts/entry-function.ts.

In the script, a function calling the test script is called.

0x1908fe0d337d7bd718c8465030c5f306377ac396f3d7acce92f526ae41637cc0::message::set_message

You may change the entry function, type arguments and arguments as you want for your own usage.

Run script with yarn

yarn run entry-function --msafe ${MSAFE_ADDR}

Action:			Entry function
Call function:		0x1908fe0d337d7bd718c8465030c5f306377ac396f3d7acce92f526ae41637cc0::message::set_message
Arguments (1):		[string]	Hello momentum safe
Sender:			0x1908fe0d337d7bd718c8465030c5f306377ac396f3d7acce92f526ae41637cc0
Sequence Number:	10
Expiration:		Thu Oct 13 2022 20:45:55 GMT-0700 (Pacific Daylight Time)
Gas Price:		100
Max Gas:		5000

--------------------

Do you confirm with the transaction? [Y/n]

After confirming the entry function, a transaction to initiate a transaction from momentum safe wallet calling message::set_message is submitted on chain.

3.3 Run move script

Run an move script using scripts/move-script.ts.

This script will run a move script with the given compiled move script.

Example move script

script {
    use aptos_framework::coin;

    fun main<T>(s: &signer, to: address, amount: u64) {
        coin::transfer<T>(s, to, amount);
    }
}

Use aptos move compile-script to compile the script. For more details, please check aptos-doc.

Run script with yarn

yarn move-script --msafe ${MSAFE_ADDR} --move-script ${SCRIPT_PATH}

Action:                 Move script
Code Hash:              0xcc424c20c47a6a41730ddab4df2f96d63f642306386733fa43e80d4120cc1eda
Type Arguments (1):     0x0000000000000000000000000000000000000000000000000000000000000001::aptos_coin::AptosCoin
Arguments (1):          bcs (031a8d1e3580c7a1c495283e07c49553a9f72250d016efc9f5268aa7a80daf9d91)
Arguments (2):          bcs (010100000000000000)
Sender:                 0x1a8d1e3580c7a1c495283e07c49553a9f72250d016efc9f5268aa7a80daf9d91
Sequence Number:        2
Expiration:             Mon Jun 05 2023 15:19:14 GMT+0800 (China Standard Time)
Gas Price:              120
Max Gas:                50000

--------------------

Do you confirm with the transaction? [Y/n]

After confirm, the transaction to initiate the multi-sig move script transaction request will be confirmed on blockchain.

Try yourself with a script

Compile the script from MSafe example script.

aptos move compile-script --package-dir ./tests/script

Compiling, may take a little while to download git dependencies...
UPDATING GIT DEPENDENCY https://github.com/aptos-labs/aptos-core.git
INCLUDING DEPENDENCY AptosFramework
INCLUDING DEPENDENCY AptosStdlib
INCLUDING DEPENDENCY MoveStdlib
BUILDING Script-test
{
  "Result": {
    "script_location": "./tests/script/script.mv",
    "script_hash": "cc424c20c47a6a41730ddab4df2f96d63f642306386733fa43e80d4120cc1eda"
  }
}

Propose a transaction with the compiled script with MSafe.

yarn move-script --msafe ${MY_MSAFE} --move-script ./tests/script/script.mv --network mainnet