Skip to content

Getting started documentation#89

Merged
8ball030 merged 24 commits intomainfrom
docs/getting-started
Nov 3, 2025
Merged

Getting started documentation#89
8ball030 merged 24 commits intomainfrom
docs/getting-started

Conversation

@Karrenbelt
Copy link
Collaborator

No description provided.

Comment on lines +5 to +22
> Assumes you have completed:
>
> - Installation ([installation.md](installation.md))
> - Account registration ([authentication.md](authentication.md))
> You should already have:
> - `DERIVE_SESSION_KEY`
> - `DERIVE_LIGHTACCOUNT`
> - `DERIVE_SUBACCOUNT`

## 1. Set Up Environment Variables

You can manage your credentials via a `.env` file to keep them out of your code:

```shell
SESSION_KEY_PRIVATE_KEY=
DERIVE_LIGHTACCOUNT=
DERIVE_SUBACCOUNT=
```
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should name this consistently: DERIVE_SESSION_KEY

Comment on lines +76 to +86
```python
# Bridge ETH for gas - ensures you can always withdraw funds
prepared_tx = client.bridge.prepare_deposit(
human_amount=0.01,
currency="ETH",
source_chain="ETH",
target_chain="DERIVE", # Goes to your EOA
)
tx_result = client.bridge.submit_deposit(prepared_tx=prepared_tx)
tx_result = client.bridge.poll_progress(tx_result=tx_result)
```
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can allow for strings so user doesn't have to import the enum if we use @validate_call for type casting to enum, making it just that much easier while still providing runtime validation

Comment on lines +22 to +31
## Step 1. Generate a Private Key

You can generate a private key using the helper script:

```shell
./scripts/generate-key.py
```

Or use an existing key

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this script I've not included in this PR yet, but i have it. It's two click commands, effectively, for generating private key, encrypting it and saving it, and another for reading it in, prompting for password to decrypt. But that's not yet integrated into the client as we have it now so will come in a separate PR later

@8ball030 8ball030 changed the base branch from main to feat/_clients_ui October 26, 2025 22:43
@8ball030 8ball030 changed the base branch from feat/_clients_ui to main October 26, 2025 22:43
@8ball030 8ball030 merged commit 7638cc9 into main Nov 3, 2025
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants