mirrorcli

This section provides a brief guide on how to use Mirror Protocol via mirrorcli. For more information, please check its source code and documentation on GitHub.
mirrorcli is a command-line interface for Mirror Protocol on Terra and allows more advanced users to perform operations directly from their shell or terminal without having to interact with a graphical interface. mirrorcli is built on top of terracli and allows you to use keys saved in its keychain.
Installation
Requirements
Make sure your have terracli installed. terracli is a binary that is shipped with Terra Core and installed in your GOPATH.
Have Node.js v10+ installed with NPM
You can install mirrorcli through NPM:
1
$ npm install -g @mirror-protocol/mirrorcli
Copied!
Configuration
On first launch, mirrorcli will generate a ~/.mirrorclirc.json in your $HOME directory, which will be used in subsequent sessions to specify settings such as LCD provider, gas prices for fee estimation, as well as contract addresses. It will come pre-configured with the official contracts for the mainnet version of Mirror on its columbus-4 setting.
The following instructions show you how to modify settings using the tequila-0004 network by default:
Specifying LCD settings
Each network config should define how to connect to the Terra blockchain via LCD parameters.
1
{
2
  "networks": {
3
    "tequila-0004": {
4
      "lcd": {
5
        "chainId": "tequila-0004",
6
        "url": "https://tequila-lcd.terra.dev",
7
        "gasPrices": {
8
          "uluna": 0.15,
9
          "usdr": 0.1018,
10
          "uusd": 0.15,
11
          "ukrw": 178.05,
12
          "umnt": 431.6259
13
        },
14
        "gasAdjustment": 1.2
15
      },
16
      ...
17
    }
18
  }
19
}
Copied!
Specifying Contracts
Each network configuration should point to the correct Mirror core contract addresses.
1
{
2
  "networks": {
3
    "tequila-0004": {
4
      ...
5
      "contracts": {
6
        "collector": "terra1v046ktavwzlyct5gh8ls767fh7hc4gxc95grxy",
7
        "community": "terra10qm80sfht0zhh3gaeej7sd4f92tswc44fn000q",
8
        "factory": "terra10l9xc9eyrpxd5tqjgy6uxrw7dd9cv897cw8wdr",
9
        "gov": "terra12r5ghc6ppewcdcs3hkewrz24ey6xl7mmpk478s",
10
        "mint": "terra1s9ehcjv0dqj2gsl72xrpp0ga5fql7fj7y3kq3w",
11
        "oracle": "terra1uvxhec74deupp47enh7z5pk55f3cvcz8nj4ww9",
12
        "staking": "terra1a06dgl27rhujjphsn4drl242ufws267qxypptx",
13
        "terraswap": "terra18qpjm4zkvqnpjpw0zn0tdr8gdzvt8au35v45xf"
14
      },
15
    ...
16
    }
17
  }
Copied!
Specifying the Network
By default, mirrorcli will use the network setting for columbus-4 configured in ~/.mirrorclirc.json. You can direct mirrorcli to use a different network configuration by changing the value of the MIRRORCLI_NETWORK environment variable.
Example
1
MIRRORCLI_NETWORK=tequila-0004 mirrorcli x mint [deposit ...]
Copied!
OR
1
export MIRRORCLI_NETWORK=tequila-0004
2
mirrorcli x mint [deposit ...]
Copied!
Usage
Usage information can be found on GitHub.

Other Proposals

Next - Developers

Mirror.js

Last modified 3mo ago

Copy link

Contents

Installation

Requirements

Configuration

Specifying LCD settings

Specifying Contracts

Specifying the Network

Usage