Iroha 2 requirements

Goals

For the functional requirements, we should follow the default use case template by example:

Use case title	[FR0000] Example use-case; ID should be unique
Preconditions	List of preconditions which must be satisfied before the use case can be applied Each precondition should be defined as the point in the list
Use case flow	The enumerated list of actions, which describes the interaction between actors step by step Each step should involve a single actor as an object of the action Each step can involve one or more actors as a subject of the action Each use case can involve other use cases as dependencies by include or extend relationships
Postconditions	One or more results of successfully finished use case
Alternative flow	List of alternative flows that can happen with the use case. Each entry should have the link to the step of the main use case flow when the alternative can occur If needed, each entry can contain sub-entries Each entry should describe the consequences of the alternative flow
Exception flow	List of exceptions that can happen during the use case flow, which can prevent it to be successfully finished Each entry should have the link to the step of the main use case flow when the exception can occur If needed, each entry can contain sub-entries Each entry should describe the consequences of the exception

Use case title	[FR0001] Starting the Iroha network
Preconditions	The administrator has configured environment for running Iroha executables The administrator has prepared the genesis block
Use case flow	The administrator launches the command to run Iroha peer and providing the path to the genesis block description The Iroha peer read and validates the genesis block configuration The Iroha peer starts the Iroha network according to the configuration in the genesis block
Postconditions	The Iroha network is running The administrator has access to the root account of the network
Alternative flow
Exception flow	On step 2, in case of invalid genesis block the Iroha peer shows corresponding error messages to the administrator and halts the network creation process

Use case title	[FR0002] Adding peer to the Iroha network
Preconditions
Use case flow
Postconditions
Alternative flow
Exception flow

Use case title	[FR0003] Removing peer from the Iroha network
Preconditions
Use case flow
Postconditions
Alternative flow
Exception flow

Use case title	[FR0004] Configuring initial state of the Iroha network
Preconditions
Use case flow
Postconditions
Alternative flow
Exception flow

Use case title	[FR0100] Sending the instruction to the Iroha network
Preconditions	The user has account in the Iroha network The user has prepared the command The user has permissions to execute the instruction The Iroha network is working in normal condition
Use case flow	The user sends the instruction to the Iroha peer through the API The Iroha peer receives the instruction and validates its contents The Iroha peer checks that the user's account have enough permissions to run the instruction The Iroha peer executes the instruction by applying it to the current block The Iroha peer returns the result of the operation to the user
Postconditions	The instruction is successfully executed and applied to the network state
Alternative flow
Exception flow	On step 2, of the instruction has invalid structure, the Iroha peer returns an error message with description to the users and stops the flow On step 3, if the user's account does not have required permissions, the Iroha peer returns information about that error and stops the flow

Use case title	[FR0101] Creation of the user in the Iroha network
Preconditions	The user has permission to create other users
Use case flow	The user prepares information about the account that should be created, which includes name, domain, the public key and permissions list The user prepares instruction to send to the Iroha network according to the prepared information The user sends the instruction to the Iroha peer (includes FR0100) Tha Iroha peer returns the result of the instruction execution to the user
Postconditions	The new account in the Iroha network is created
Alternative flow
Exception flow

Use case title	[FR0102] Configuring permissions for the account in the Iroha network
Preconditions
Use case flow
Postconditions
Alternative flow
Exception flow

Use case title	[FR0102] Granting permissions for the account in the Iroha network
Preconditions	The user has access to his/her account in the Iroha network The user's account has permissions to provide grantable permissions
Use case flow	The user prepares the instruction to grant one or more permissions to another account The user sends the instruction with the prepared instruction to the Iroha peer (includes FR0100) The Iroha peer returns the result of the instruction to the user
Postconditions	The permission was granted to another account
Alternative flow
Exception flow

Use case title	[FR0104] Sending complex instruction using ISI DSL
Preconditions
Use case flow
Postconditions
Alternative flow
Exception flow

Use case title	[FR0200] Acquiring data from the Iroha network by query
Preconditions
Use case flow
Postconditions
Alternative flow
Exception flow

Use case title	[FR0201] Acquiring the information about the selected account
Preconditions
Use case flow
Postconditions
Alternative flow
Exception flow

Use case title	[FR0202] Acquiring of the current permissions for the selected account
Preconditions
Use case flow
Postconditions
Alternative flow
Exception flow

Below is a list of questions to be addressed as a result of this requirements document:

Question	Outcome