Readme corrections

README.md

@@ -53,4 +53,4 @@ cargo r --release --bin moat-cli-sp -- --wallet-pass <PASSWORD>
 
 ## Moat API
 
-An API meant for developers willing to integrate Citadel in their code is available [here](https://github.com/dusk-network/moat/blob/main/moat-core/src/api.rs). You can find an example on how to use the API into `moat-example`.
+An API meant for developers willing to integrate Citadel in their code is available [here](https://github.com/dusk-network/moat/blob/main/moat/src/api.rs). You can find an example on how to use the API into `moat-example`.

moat-cli/moat-cli-lp/README.md

@@ -8,24 +8,12 @@ Available commands:
 - issue license for a given request
 - list licenses
 
-## Retrieve relevant license requests (LP)
+## Retrieve relevant license requests
 
-arguments:
-- scope: either an entire blockchain, or block range, or N last blocks
-- data for Rusk cluster connection
-- LP's view key (created from LP's SSK)
+## Issue license for a given request
 
-## Issue license for a given request (LP)
-
-arguments:
-- data for wallet connection
-- data for Rusk cluster connection
-- gas limit
-- gas price
-- license (created from the relevant request and LP's SSK)
+Arguments:
+- request hash
+- attribute data
 
 ## List licenses
-
-arguments:
-- scope: block height range
-- data for Rusk cluster connection

moat-cli/moat-cli-sp/README.md

@@ -4,6 +4,15 @@ Command line interface to Dusk Citadel Service Provider
 
 Available commands:
 
-- request and obtain service from SP based one a session cookie
-- get session from license contract based on a session id
-- show license contract state
+- verify requested service
+- get session
+
+## Verify Requested Service
+
+Arguments:
+- session cookie
+
+## Get Session
+
+Arguments:
+- session id

moat-cli/moat-cli-user/README.md

@@ -4,46 +4,23 @@ Command line interface to Dusk Citadel User
 
 Available commands:
 
-- submit a license request to blockchain (USER)
-- list requests present on blockchain (USER)
-- list user's licenses (USER)
-- compute proof and use license (USER)
-- obtain service from SP (USER & SP)
+- submit a license request to blockchain
+- list user's licenses
+- use license
+- request service from SP (Off-Chain)
 
-## Submit a license request to blockchain (User)
+## Submit a license request to blockchain
 
-arguments:
-- data for wallet connection
-- data for Rusk cluster connection
-- user SSK (Secret Spend Key)
-- provider PSK (Public Spend Key)
-- gas limit
-- gas price
+Arguments:
+- address of the license provider
 
-## Retrieve from blockchain the requests which were sent by the user (User)
+## List user's licenses
 
-arguments:
-- scope: either an entire blockchain, or block range, or N last blocks
-- data for Rusk cluster connection
-- user's view key (created from user's SSK)
+## Use license
 
-## List user's licenses (User)
-
-arguments:
-- scope: block height range
-- data for Rusk cluster connection
-- user's view key (created from user's SSK)
-
-## Use license (User)
-
-arguments:
-- data for wallet connection
-- data for Rusk cluster connection
-- license
-- more - TBD
-
-## Obtains service from SP (User and SP)
-
-arguments:
-TBD as we need to mock SP
+Arguments:
+- license hash
+- address of the license provider
+- address of the service provider
+- value of the challenge
 

moat/CHANGELOG.md

@@ -7,7 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [0.1.0] - 2023-11-28
+## [0.1.0] - 2023-12-01
 
 ### Added
 

moat/Cargo.toml

@@ -1,6 +1,11 @@
 [package]
 name = "zk-citadel-moat"
 version = "0.1.0"
+authors = [
+    "Milosz Muszynski <[email protected]>",
+    "Xavier Salleras Soler <[email protected]>"
+]
+
 edition = "2021"
 
 [dependencies]