- Masa CLI
- Overview
- Usage / Installation
- Commands
masa loginmasa logoutmasa accountmasa identitymasa soul-namemasa soul-name infomasa soul-name listmasa soul-name tailmasa soul-name resolve <soulname>masa soul-name resolve-reverse <soulname>masa soul-name create <soulname> <duration>masa soul-name burn <soulname>masa soul-name send <soulname> <receiver>masa soul-name show <soulname>masa soul-name verify <soulname>
masa credit-scoremasa credit-score infomasa credit-score listmasa credit-score createmasa credit-score burn <credit-score-id>masa credit-score load <credit-score-id>masa credit-score linkmasa credit-score link create <credit-score-id> <reader-identity-id>masa credit-score link establish <passport>masa credit-score link query <passport>masa credit-score link list <credit-score-id>masa credit-score link verify <credit-score-id>masa credit-score link break <credit-score-id> <reader-identity-id>
masa greenmasa sbtmasa settings
- Configuration
$ masa --help
__ __ ____ _ ___
| \/ | __ _ ___ __ _ / ___| | | |_ _|
| |\/| | / _` | / __| / _` | | | | | | |
| | | | | (_| | \__ \ | (_| | | |___ | |___ | |
|_| |_| \__,_| |___/ \__,_| \____| |_____| |___|
Usage: masa [command] [subcommand] [arguments] [options]
The Masa CLI
Options:
-v, --version output the version number
--verbose output with verbose logging
-h, --help display help for command
Commands:
login Login to the masa infrastructure
logout Logout from the masa infrastructure
account Shows information about your account
identity Identity commands
identity info Shows info about all Identities
identity create <soulname> <duration> Creates a masa identity with soul name
identity register Creates a masa identity without soul name
identity show [options] Shows detail about your masa identity
identity burn Burns your masa identity
soul-name Soul Name Commands
soul-name info Shows info about all Soul Names
soul-name list [options] Lists your soul names
soul-name tailoptions] Tails your soul names
soul-name resolve <soulname> Resolves a soul name to the address
soul-name resolve-reverse <soulname> Resolves an address to soul names
soul-name create <soulname> <duration> Creates a new soul name
soul-name burn <soulname> Burns soul name that you own
soul-name send <soulname> <receiver> Sends a soul name to that you own to a receiver
soul-name show <soulname> Shows info about a Soul Name
soul-name verify <soulname> Verifies a Soul Name
credit-score Credit Score Commands
credit-score info Shows info about all Credit Scores
credit-score list [options] Lists your Credit Scores
credit-score create Creates a Credit Score
credit-score burn <credit-score-id> Burns a Credit Score
credit-score load <credit-score-id> Loads a Credit Score
credit-score link Credit Score Soul Linker Commands
credit-score link create <credit-score-id> <reader-identity-id> Creates a Soul Linker Passport
credit-score link establish <passport> Establishes a link to a Credit Score
credit-score link query <passport> Queries a link to a Credit Score
credit-score link list <credit-score-id> Lists all soul links for a credit report id
credit-score link verify [options] <credit-score-id> Verifies soul link
credit-score link break <credit-score-id> <reader-identity-id> Verifies soul link
green Green Commands
green info Shows info about Masa Green
green list [options] Lists your Greens
green create <phone-number> Creates a Green Token
green burn <green-id> Burns a green
sbt SBT Commands
sbt info <contract-address> Shows info about an SBT
sbt list [options] <contract-address> Lists your SBTs
sbt sign <contract-address> <name> <types> <value> Signs an SBT
sbt prepare-mint <contract-address> <name> <types> <value> <authority-address> <signature> Prepares an SBT mint operation
sbt burn <contract-address> <sbt-id> Burns an SBT
settings Set config settings
settings set <key> <value> Changes setting <key> to <value>
settings preset <environment> Changes setting <environment> presets
settings preset-network <network-name> Changes setting <network-name> presets
settings show Shows config values
help [command] display help for commandTo get help for a specific command use:
$ masa identity --helpto get help for the identity commands.
npm install -g @masa-finance/masa-cli
$ masa --version
CLI: v0.1.0 Contracts: v0.3.0 SDK: v0.9.1
Arweave Endpoint: https://arweave.net:443
RPC Endpoint: https://rpc.ankr.com/eth_goerli
Masa Endpoint: https://dev.middleware.masa.finance/yarn global add @masa-finance/masa-cli
$ masa --version
CLI: v0.1.0 Contracts: v0.3.0 SDK: v0.9.1
Arweave Endpoint: https://arweave.net:443
RPC Endpoint: https://rpc.ankr.com/eth_goerli
Masa Endpoint: https://dev.middleware.masa.finance/$ npx @masa-finance/masa-cli@latest --version
CLI: v0.1.0 Contracts: v0.3.0 SDK: v0.9.1
Arweave Endpoint: https://arweave.net:443
RPC Endpoint: https://rpc.ankr.com/eth_goerli
Masa Endpoint: https://dev.middleware.masa.finance/Login to the masa infrastructure
Logout from the masa infrastructure
Shows information about your account
Identity commands
Shows info about all Identities
Creates a masa identity with soul name
<soulname> Soul Name to register<duration> Period of registration
Creates a masa identity without soul name
Shows detail about your masa identity
Options:
-a, --address <address>Address override
Burns your masa identity
Soul Name Commands
Shows info about all Soul Names
Lists your soul names
Options:
-a, --address <address>Address override
Tails your soul names
Options:
-l, --limit <limit>Limit
Resolves a soul name to the address
<soulname> Soul Name to resolve
Resolves an address to soul names
<soulname> Address to resolve
Creates a new soul name
<soulname> soulname to register<duration> period of registration
Burns soul name that you own
<soulname> Soul Name to burn
Sends a soul name to that you own to a receiver
<soulname> Soul Name to send<receiver> Receiver to receive the Soul Name
Shows info about a Soul Name
<soulname> Soul Name to show
Verifies a Soul Name
<soulname> Soul Name to verify
Credit Score Commands
Shows info about all Credit Scores
Lists your Credit Scores
Options:
-a, --address <address>Address override
Creates a Credit Score
Burns a Credit Score
<credit-score-id> ID of the Credit Score to burn
Loads a Credit Score
<credit-score-id> ID of the Credit Score to load
Credit Score Soul Linker Commands
Creates a Soul Linker Passport
<credit-score-id> ID of the Credit Score to grant access<reader-identity-id> ID of the identity that should receive access
Establishes a link to a Credit Score
<passport> Masa Soul Linker passport
Queries a link to a Credit Score
<passport> Masa Soul Linker passport
Lists all soul links for a credit report id
<credit-score-id> ID of the Credit Score to list all the links of
Verifies a Soul Link
<credit-score-id> ID of the Credit Score to grant accessOptions:-r, --reader-identity-id <reader-identity-id>ID of the identity that should receive access
Breaks a Soul Link
<credit-score-id> ID of the Credit Score to grant access<reader-identity-id> ID of the identity that should receive access
Green Commands
Shows info about Masa Green
Lists your Greens
Options:
-a, --address <address>Address override
Creates a Green Token
<phone-number> The phone number to verify
Burns a green
<green-id> ID of the Green to burn
SBT Commands
Shows info about an SBT
<contract-address> Address of the SBT to sign
Lists your SBTs
<contract-address> Address of the SBT contract to listOptions:-a, --address <address>Address override
Signs an SBT
<contract-address> Address of the SBT to sign<name> Name of the contract<types> Types structure to sign<value> Values of the structure
Prepares an SBT mint operation
<contract-address> Address of the SBT to sign<name> Name of the contract<types> Types structure to sign<value> Values of the structure<authority-address> Authority address used for signing<signature> Signature from the signing step
Burns an SBT
<contract-address> Address of the SBT to sign<sbt-id> ID of the SBT to burn
Set config settings
Changes setting <key> to <value>
<key> key to set<value> value to set to key
Changes setting <environment> presets
<environment> The environment to use as preset
Changes setting <network-name> presets
<network-name> The network to use as preset
Shows config values
All the below fields can be set with:
$ masa settings set <key> <value>| Key | Type | Description | Default Value |
|---|---|---|---|
| cookie | string |
Stores cookie value. Don't set this manually unless you know what you do! | |
| api-url | string |
The API Endpoint of the Masa Infrastructure for dev, test, beta and production. |
"https://dev.middleware.masa.finance/" |
| environment | string |
The environment to use dev, test, beta, production. |
"dev" |
| rpc-url | string |
The RPC Endpoint to reach the Blockchain. | "https://rpc.ankr.com/eth_goerli" |
| network | string |
The network name ie. "goerli". | "goerli" |
| private-key | string |
Your private key of the account to use in the cli. | ethers.Wallet.createRandom().privateKey |
| arweave-host | string |
The arweave host to use for loading metadata. | "arweave.net" |
| arweave-port | number |
The arweave port to use for loading metadata. | 443 |
| arweave-protocol | string |
The arweave protocol to use for loading metadata. | "https" |
| arweave-logging | boolean |
Turn arweave logging on or off. | false |