Injective docs on Gitbook have been deprecated, and the information is no longer updated
Visit docs.injective.network for up to date Injective docs
Edit

Using injectived

The following page explains what one can do via injectived, the command-line interface that connects to Injective. You can use injectived to interact with the Injective blockchain by uploading smart contracts, querying data, managing staking activities, working with governance proposals, and more.

Prerequisites

Ensuring injectived is installed

See Install injectived for more information. If you have installed injectived successfully, you should be able to run the following command:

injectived version

Please adjust your command to use the home dir properly.

injectived keys list --home ~/.injective

Using Dockerized CLI

In case when running from Docker, you have to mount the home dir to the container.

docker run -it --rm -v ~/.injective:/root/.injective injectivelabs/injective-core:v1.14.1 injectived keys list --home /root/.injective

Adding a key using Dockerized CLI is straightforward.

docker run -it --rm -v ~/.injective:/root/.injective injectivelabs/injective-core:v1.14.1 injectived keys add my_key --home /root/.injective

There's a breakdown of that command:

  • docker runs the image injectivelabs/injective-core:v1.14.1

  • injectived is the command to run the CLI from within the container

  • keys add is the command to add a key

  • my_key is the name of the key

  • --home /root/.injective is the home directory for CLI inside the container

  • -v ~/.injective:/root/.injective simply mounts the host ~/.injective dir to the container's /root/.injective dir.

It will create a key pair and save it to the container's /root/.injective/keyring-file dir, which is the same as your host ~/.injective/keyring-file dir.

You can list all the keys by running:

Using the RPC endpoint

Before you can access the Injective blockchain, you need to have a node running. You can either run your own full node or connect to someone else’s.

To query the state and send transactions, you must connect to a node, which is the access point to the entire network of peer connections. You can either run your own full node or connect to someone else’s.

Running own node is for advanced users only. For most users, it is recommended to connect to a public node.

To set the RPC endpoint, you can use the following command:

For testnet only, you can use: https://k8s.testnet.tm.injective.network:443 (chain-id injective-888)

Now try to query the state:

General help

For more general information about injectived, run:

For more information about a specific injectived command, append the -h or --help flag after the command. For example:

Configuring injectived client

To configure more options of injectived, edit the config.toml file in the ~/.injective/config/ directory. Keyring file is located in ~/.injective/keyring-file directory when keyring-backend is set to file. It's possible to set keyring-backend to test or os as well. In case for the test, it will be also stored as file ~/.injective/keyring-test but not password-protected.

All options in the file can be set using the CLI: injectived config set client <option> <value>.

Generate, Sign, and Broadcast a Transaction

Running the following command sends INJ tokens from the sender's account to the recipient's account. 1000inj is the amount of INJ tokens to send, where 1 INJ = 10^18 inj, so 1000inj is a really small amount.

The following steps are performed:

  • Generates a transaction with one Msg (x/bank's MsgSend), and print the generated transaction to the console.

  • Ask the user for confirmation to send the transaction from the $MY_WALLET account.

  • Fetch $MY_WALLET from the keyring. This is possible because we have set up the CLI's keyring in a previous step.

  • Sign the generated transaction with the keyring's account.

  • Broadcast the signed transaction to the network. This is possible because the CLI connects to the public Injective node's RPC endpoint.

The CLI bundles all the necessary steps into a simple-to-use user experience. However, it is possible to run all the steps individually as well.

(Only) Generating a Transaction

Generating a transaction can simply be done by appending the --generate-only flag on any tx command, e.g.,

This will output the unsigned transaction as JSON in the console. We can also save the unsigned transaction to a file (to be passed around between signers more easily) by appending > unsigned_tx.json to the above command.

Signing a pre-generated Transaction

Signing a transaction using the CLI requires the unsigned transaction to be saved in a file. Let's assume the unsigned transaction is in a file called unsigned_tx.json in the current directory (see previous paragraph on how to do that). Then, simply run the following command:

This command will decode the unsigned transaction and sign it with SIGN_MODE_DIRECT with MY_WALLET's key, which we already set up in the keyring. The signed transaction will be output as JSON to the console, and, as above, we can save it to a file by appending > signed_tx.json to the commandline.

Some useful flags to consider in the tx sign command:

  • --sign-mode: you may use amino-json to sign the transaction using SIGN_MODE_LEGACY_AMINO_JSON,

  • --offline: sign in offline mode. This means that the tx sign command doesn't connect to the node to retrieve the signer's account number and sequence, both needed for signing. In this case, you must manually supply the --account-number and --sequence flags. This is useful for offline signing, i.e., signing in a secure environment which doesn't have access to the internet.

Signing with multiple signers (Multi Sig)

Signing with multiple signers is done with the tx multi-sign command. This command assumes that all signers use SIGN_MODE_LEGACY_AMINO_JSON. The flow is similar to the tx sign command flow, but instead of signing an unsigned transaction file, each signer signs the file signed by previous signer(s). The tx multi-sign command will append signatures to the existing transactions. It is important that signers sign the transaction in the same order as given by the transaction, which is retrievable using the GetSigners() method.

For example, starting with the unsigned_tx.json, and assuming the transaction has 4 signers, we would run:

Broadcasting a Transaction

Broadcasting a transaction is done using the following command:

You may optionally pass the --broadcast-mode flag to specify which response to receive from the node:

  • block: the CLI waits for the tx to be included in a block.

  • sync: the CLI waits for a CheckTx execution response only, query transaction result manually to ensure it was included.

  • async: the CLI returns immediately (transaction might fail) - DO NOT USE.

To query the transaction result, you can use the following command:

Additional Troubleshooting

Sometimes the config is not set correctly. You can force the correct node RPC endpoint by adding the following to the commandline. When sharing commands with others, it is recommended to have all the flags explicitly set in the commandline. (chain-id, node, keyring-backend, etc.)

PreviousInstall injectivedNextinjectived Commands

Last updated