Swen dev v4 cli pt 1/x

.gitignore

@@ -1,21 +1,42 @@
-/program/target
-/program/Cargo.lock
-*/.coderrect
-/program/dist/program/*.so
-*/*.so
-test-ledger
-/program/dist/
-/program/docker-target
+/test-ledger/
+# CLI
+/cli/node_modules/
+/cli/build/
+/cli/cache/secret.txt
+/cli/cache/utxos.txt
+/cli/cache/signature.txt
+/cli/cache/user.txt
+/cli/lookupTable.txt
+/cli/build/cli.js
+/cli/build/lookupTable.txt
+*/light-test-cache/
 
-/program_merkle_tree/target
-/program_merkle_tree/Cargo.lock
-/program_merkle_tree/dist/program/*.so
 
-/program_merkle_tree/dist/
-/program_merkle_tree/docker-target
-groth16-solana/target
-light-verifier-sdk/target
+# relayer
+/relayer/node_modules/
+
+# light-sdk-ts
+/light-sdk-ts/node_modules/
+/light-sdk-ts/lib/
+/light-sdk-ts/lookUpTable.txt
+
+# light-system-programs
+/light-system-programs/node_modules/
+/light-system-programs/target/
+/light-system-programs/tests/*.js
+
+# light-verifier-sdk
+/light-verifier-sdk/target/
+
+# other
+/groth16-solana/target
 */target/*
 /anchor_programs/build/*
 /anchor_programs/Light_Circuits/build/circuits/ptau17
-light-sdk/node_modules/*
+/light-system-programs/lookUpTable.txt
+/groth16-solana/target/
+*/target/*
+
+# light-circuits
+/light-circuits/node_modules/
+/light-circuits/lookUpTable.txt

README.md

@@ -22,19 +22,23 @@ _Requirements:_
 ## Tests
 
 _Global:_
+
 - `sh test.sh`
 
 _Rust tests:_
+
 - `cd groth16-solana/`
 - `cargo test`
 - `cd light-verifier-sdk/`
 - `cargo test`
 
 _Sdk tests:_
+
 - `cd light-sdk-ts/`
 - `npm test`
 
 _Circuit tests:_
+
 - `cd light-circuits`
 - `npm test`
 
@@ -46,19 +50,23 @@ The default test is a functional test, setting up a test environment with a merk
 Tests can be executed in bulk or one by one.
 
 **Without external validator:**
+
 - `cd light-system-programs/`
 - `npm test`
 - `npm test-verifiers`
 - `npm test-merkle-tree`
 
-
 **Manual:**
 
 - Assuming that your clones of `solana` and `light-protocol-onchain` git
   repositories share the same parent directory and you are currently in the
   `light-protocol-onchain` directory, launch a validator with the following
   command:
 
+1. cargo build in light-verifier-sdk (optional)
+2. anchor build in light-system-programs
+3. anchor build in mock-app-verifier
+
 ```
 ../solana/validator/solana-test-validator \
     --reset \
@@ -74,3 +82,20 @@ Tests can be executed in bulk or one by one.
 - `anchor test --skip-build --skip-deploy --skip-local-validator`
 
 Check logs in anchor_programs/.anchor/program-logs
+w
+
+## Todos
+
+### Swen
+
+[ ] - add encryption to file storage (cli)
+
+[ ] - "privamount" -> "shieldedAmount", 2 amounts passable w SPL support
+
+[ ] - userTokenPda -> as variable input w SPL support
+
+[ ] - relayer should recevie ixs instead of txs
+
+[ ] - remove testaccountsetup fns (part of spl support)
+
+[ ] - remove 2 airdrop checks for relayer recipient (currently randomly generated inside transfer/unshield), part of relayer activation

build-sdk.sh

@@ -1,4 +1,5 @@
-cd light-sdk-ts && npm run build & sleep 5 && kill $! && cd ..  ;
-cd light-circuits && rm node_modules/light-sdk/ -r && npm i && cd -;
-cd light-system-programs && rm node_modules/light-sdk/ -r && npm i && cd -;
-cd mock-app-verifier && rm node_modules/light-sdk/ -r && npm i && cd -;
+cd light-sdk-ts && npm run build & sleep 5 && kill $! && cd ..;
+cd light-circuits && npm i && cd -;
+cd light-system-programs && npm i && cd -;
+cd mock-app-verifier && npm i && cd -;
+

cli/.prettierc

@@ -0,0 +1,5 @@
+{
+  "trailingComma": "all",
+  "tabWidth": 2,
+  "singleQuote": false
+}

cli/README.md

@@ -0,0 +1,27 @@
+### v3 CLI
+
+- meant to replicate all typical uses of the Light SDK that any UI or wallet would implement too.
+- /cli/src/commands -> UI
+- build with `npx tsc`
+
+- ./build/cli.js <command> <params> -flag
+
+COMMANDS
+
+initial setup:
+
+./build/cli.js balance
+
+consecutive:
+./build/cli.js shield --amount=3 --token=SOL
+
+./build/cli.js unshield --amount=1 --token=SOL --recipient=ErAe2LmEKgBNCSP7iA8Z6B396yB6LGCUjzuPrczJYDbz
+
+./build/cli.js transfer --amount=1 --token=SOL --shieldedRecipient=19a20668193c0143dd96983ef457404280741339b95695caddd0ad7919f2d434 --encryptionPublicKey=LPx24bc92eecaf5e3904bc1f4f731a2b1e0a28adf445e800c4cff112eb7a3f5350b
+
+### TODOs Swen
+
+- [] enable SPL support
+- [] implement relayer (/relayer) WIP, replace relayer 'mocks' in user class
+- [] add test cases [e.g. merging >2 inUtxos, 10-in circuit, extend checkBalance() for multiple out-utxos]
+- [] test-case with browser wallet instead of CLI