From f0971e0c4ea651d66d13f49be6fb9c6c046fba37 Mon Sep 17 00:00:00 2001 From: glihm Date: Sun, 21 Jan 2024 09:53:47 -0600 Subject: [PATCH] docs: add ACCOUNT_IS_LEGACY to documentation --- README.md | 2 ++ book/src/globals_variables.md | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/README.md b/README.md index 1dcabe7..94d4086 100644 --- a/README.md +++ b/README.md @@ -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`. diff --git a/book/src/globals_variables.md b/book/src/globals_variables.md index 8d09eb2..6a8976e 100644 --- a/book/src/globals_variables.md +++ b/book/src/globals_variables.md @@ -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" ``` @@ -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** >