Skip to content

Commit

Permalink
docs: add ACCOUNT_IS_LEGACY to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
glihm committed Jan 21, 2024
1 parent 563f54d commit f0971e0
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,14 @@ If you prefer a short cheatsheet, go [here](https://devhints.io/lua) or [here](h
To test Kipt, the easiest way is:

1. Install Kipt

```bash
# 1. Install
curl https://raw.githubusercontent.com/glihm/kipt/main/kiptup/install | sh
source ~/.bashrc
kiptup
```

2. Create a simple "demo.lua" script copying the example below, replacing with the name of your contract.
3. Spin up katana in an other terminal.
4. Run `kipt --lua ./demo.lua`.
Expand Down
4 changes: 4 additions & 0 deletions book/src/globals_variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ RPC = "GOERLI-1"
ACCOUNT_ADDRESS = "0x1234...."
ACCOUNT_PRIVKEY = "0x8888...."

-- If you're using a cairo 0 account, you will need legacy encoding.
-- ACCOUNT_IS_LEGACY = true

-- You can re-defined anywhere in the script a new value
RPC = "http://0.0.0.0:5050"
```
Expand All @@ -27,6 +30,7 @@ As shown, some global variables are expected by Kipt:

- `ACCOUNT_ADDRESS`: The address of the account to use to send transactions.
- `ACCOUNT_PRIVKEY`: The private key of the account to use to send transactions.
- `ACCOUNT_IS_LEGACY`: Specifies if the account is a cairo 0 account.

> ℹ️ **Note**
>
Expand Down

0 comments on commit f0971e0

Please sign in to comment.