Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ EigenCompute uses two types of keys:
* Authentication keys for deployments and protocol interactions.
* TEE mnemonic for applications and wallet functionality inside the TEE.

For more information on EigenCompute keys, refer to the Keys Overview concept topic.
For more information on EigenCompute keys, refer to the [Keys](../../concepts/keys-overview.md) concept topic.
:::

New authentication keys are required for:
Expand All @@ -35,6 +35,14 @@ Address: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb1
✓ You can now use eigenx commands without additional authentication
```

:::warning
The private key is securely stored while you remain authenticated to EigenCompute.

If you log out of EigenCompute and have not backed up the private key that was generated for you, you will be unable to access your deployed application.

If you generate another EigenCompute key and overwrite the existing private key without first having backed up the private key that was generated for you, you will be unable to access your deployed application.
:::

To create and securely store an authentication key for a specific environment:

```
Expand Down
Original file line number Diff line number Diff line change
@@ -1,58 +1,16 @@
---
title: Manage Authentication Keys
sidebar_position: 2
sidebar_position: 3
---

:::important
EigenCompute uses two types of keys:
* Authentication keys for deployments and protocol interactions.
* TEE mnemonic for applications and wallet functionality inside the TEE.

For more information on EigenCompute keys, refer to the Keys Overview concept topic.
For more information on EigenCompute keys, refer to the [Keys](../../concepts/keys-overview.md) concept topic.
:::

## Log in to EigenX

When using EigenX, logging in refers to providing your authentication key to the EigenX command line. The following methods
are supported and checked in this order:

1. `--private-key` flag on any command (not recommended).
2. `EIGENX_PRIVATE_KEY` environment variable.
3. OS keyring securely stored credentials.

:::warning
Using the `--private-key` flag to provide your private key directly on the command line is not recommended. When provided on the command line
it may be stored in your shell history. Use the OS keyring to securely store credentials or the `EIGENX_PRIVATE_KEY` environment
variable for CI/CD pipelines.
:::

Log in to:
* Import an existing key from Metamask or another wallet.
* Store your allowlisted wallet after receiving access.
* Configure the EigenX CLI on a new machine.

To log in by storing your authentication key in the OS keyring, use the interactive login:

```bash
eigenx auth login
```

The CLI will prompt you to enter your private key:

```
Enter your private key: [hidden input]
Address: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb1

✓ Private key stored securely in OS keyring
✓ You can now use eigenx commands without additional authentication
```

Use the `--env` flag to log in to a specific environment:

```bash
eigenx auth login --env sepolia
```

## Check authentication status

Check the authentication status to:
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Use Existing Authentication Keys
sidebar_position: 2
---

When using EigenX, logging in refers to providing your authentication key to the EigenX command line. The following methods
are supported and checked in this order:

1. `--private-key` flag on any command (not recommended).
2. `EIGENX_PRIVATE_KEY` environment variable.
3. OS keyring securely stored credentials.

:::warning
Using the `--private-key` flag to provide your private key directly on the command line is not recommended. When provided on the command line
it may be stored in your shell history. Use the OS keyring to securely store credentials or the `EIGENX_PRIVATE_KEY` environment
variable for CI/CD pipelines.
:::

Log in to:
* Import an existing key from Metamask or another wallet.
* Configure the EigenX CLI on a new machine.

To log in by storing your authentication key in the OS keyring, use the interactive login:

```bash
eigenx auth login
```

The CLI will prompt you to enter your private key:

```
Enter your private key: [hidden input]
Address: 0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb1

✓ Private key stored securely in OS keyring
✓ You can now use eigenx commands without additional authentication
```

Use the `--env` flag to log in to a specific environment:

```bash
eigenx auth login --env sepolia
```