Specifications#
+Specifications [DRAFT]#
+
+
Warning
+These specs are still in active development, and are subject to change.
+This document outlines the detailed specifications for our project. Each section in this document corresponds to a different component of the system and is further divided into two categories: Functional Requirements and Security Requirements.
-
@@ -255,13 +259,14 @@
SpecificationsFunctional requirements# -
Repositories#
+Distribution system#
+Repositories#
Functional interface requirements are described in IRepository, functionality must fulfill following unit tests:
- It emits
VersionCreatedwhencreateVersionis called successfully
- - It reverts with
InvalidReleaseIncrementif a release number is incremented by more than one
+ - It reverts with
EmptyReleaseMetadataif no metadata is supplied increateVersion - It reverts with
ReleaseZeroNotAllowedif a release number is set to zero increateVersion - When no release nor version exists:
- When version and release exists:
-
+
- It reverts with
InvalidReleaseIncrementif a release number is incremented by more than one
+ - It reverts with
EmptyReleaseMetadataif no metadata is supplied inupdateReleaseMetadata - It reverts with
AlreadyInPreviousReleaseifcreateVersionif the same source address
- - It returns correct release count for given major version upon calling
buildCount
+ - It emits
VersionCreatedwhencreateVersionis called with valid major version increment
+ - It emits
VersionCreatedwhencreateVersionis called with valid minor version increment
+ - It returns correct count for given major version upon calling
buildCount - It returns correct
VersionifgetVersionis called with valid major and minor version
+ - It returns correct
VersionifgetVersionis called with valid tagHash - It returns correct
VersionifgetLatestVersion(address)is called - It returns correct
VersionifgetLatestVersion(uint8)is called - It emits
ReleaseMetadataUpdatedwhenupdateReleaseMetadatais called successfully
+ - It returns correct release count if
latestReleaseis called
- It reverts with
Optional requirementsIRankifyInstanceCommons
- It emits
Installer#
-installer must implement IRepoInstaller interface, functionality must fulfill following unit tests:
+Instantiator#
+installer must implement IInstantiator interface, functionality must fulfill following unit tests:
- it emits
RepositoryAddedifaddRepositoryis called successfully. - it emits
Instantiatedifinstantiateis called successfully.
- - it reverts with
RepositoryDoesNotExistifinstantiateis called with non-existing repository.
- - it reverts with
VersionDoesNotMatchRequirementifinstantiateversion does not match.
+ - it reverts with
NotDistributingifinstantiateis called with non-existing repository.
+ - it reverts with
VersionOutOfBoundsifinstantiateversion does not match. - it emits
RepositorRemovedwhenremoveRepository` is called successfully. - it emits
InstantiatedifinstantiateLatestis called successfully. - it reverts with
RepositoryDoesNotExistifinstantiateLatestis called with non-existing repository. - when repository already exists:
-
-
- it emits
RepositoryRequirementUpdatedifaddRepositoryis called successfully with already existing repository.
+ - it emits
DistributionChangedifupgradeDistributionis called successfully with already existing repository.
- - it emits
- when
RepositoryRequirementUpdatedwas emitted:-
-
- it reverts with
VersionDoesNotMatchRequirementif instance version does not match requirement anymore.
+ - when
DistributionChangedwas emitted:-
+
- it reverts with
VersionOutOfBoundsupon calling installation methods with outdated version.
+ - it reverts with
VersionDeprecatedupon outdated version instance attempting to call installation target. - it emits
Upgradedifupgradeis called successfully.
- - it reverts with
VersionDoesNotMatchRequirementifupgradeis called with version that does not match the required version.
+ - it reverts with
VersionOutOfBoundsifupgradeis called with version that does not match the required version.
- it reverts with
- It returns correct
RepositoryifgetRepositoryis called with valid instance address
@@ -334,8 +346,8 @@
InstallerInstance [TBD]#
Security requirements#
@@ -370,7 +382,6 @@Rankify MultisigApp Instances#
-Installer [TBD]#
- it reverts with