From 37905c208a3e364a616fb015fe139c8f9bb5fe65 Mon Sep 17 00:00:00 2001 From: Marc Doerflinger Date: Fri, 22 Mar 2024 10:27:09 +0000 Subject: [PATCH] add README.adoc (#297) --- contracts/instance/module/README.adoc | 15 +++++++++++++ contracts/instance/service/README.adoc | 29 ++++++++++++++++++++++++++ contracts/registry/README.adoc | 16 ++++++++++++++ contracts/shared/README.adoc | 23 ++++++++++++++++++++ contracts/types/README.adoc | 26 +++++++++++++++++++++++ 5 files changed, 109 insertions(+) create mode 100644 contracts/instance/module/README.adoc create mode 100644 contracts/instance/service/README.adoc create mode 100644 contracts/registry/README.adoc create mode 100644 contracts/shared/README.adoc create mode 100644 contracts/types/README.adoc diff --git a/contracts/instance/module/README.adoc b/contracts/instance/module/README.adoc new file mode 100644 index 000000000..4d916be6a --- /dev/null +++ b/contracts/instance/module/README.adoc @@ -0,0 +1,15 @@ += Modules + +Contains the instance module contracts. + +== Contracts + +{{IAccess}} +{{IBundle}} +{{IComponents}} +{{IDistribution}} +{{IPolicy}} +{{IRisk}} +{{ISetup}} +{{ITreasury}} + diff --git a/contracts/instance/service/README.adoc b/contracts/instance/service/README.adoc new file mode 100644 index 000000000..03c792ffd --- /dev/null +++ b/contracts/instance/service/README.adoc @@ -0,0 +1,29 @@ += Service + +Contains the instance service contracts. + +== Contracts + +{{ApplicationServiceManager}} +{{BundleServiceManager}} +{{ClaimServiceManager}} +{{DistributionServiceManager}} +{{IApplicationService}} +{{IClaimService}} +{{IPolicyService}} +{{IProductService}} +{{PolicyService}} +{{PoolService}} +{{ProductService}} +{{ApplicationService}} +{{BundleService}} +{{ClaimService}} +{{DistributionService}} +{{IBundleService}} +{{IDistributionService}} +{{IPoolService}} +{{PolicyServiceManager}} +{{PoolServiceManager}} +{{ProductServiceManager}} + + diff --git a/contracts/registry/README.adoc b/contracts/registry/README.adoc new file mode 100644 index 000000000..0da849a5d --- /dev/null +++ b/contracts/registry/README.adoc @@ -0,0 +1,16 @@ += Registry + +Contains the registry related contracts. + +== Contracts + +{{ChainNft}} +{{IRegistryService}} +{{IRegistry}} +{{ITransferInterceptor}} +{{RegistryAccessManager}} +{{RegistryServiceManager}} +{{RegistryService}} +{{Registry}} +{{ReleaseManager}} +{{TokenRegistry}} diff --git a/contracts/shared/README.adoc b/contracts/shared/README.adoc new file mode 100644 index 000000000..7170a3352 --- /dev/null +++ b/contracts/shared/README.adoc @@ -0,0 +1,23 @@ += Shared + +Contains the shared contracts. + +== Contracts + +{{ContractDeployerLib}} +{{ERC165}} +{{INftOwnable}} +{{IPolicyHolder}} +{{IRegisterable}} +{{IRegistryLinked}} +{{IService}} +{{IVersionable}} +{{NftOwnable}} +{{PolicyHolder}} +{{ProxyManager}} +{{Registerable}} +{{RegistryLinked}} +{{Service}} +{{TokenHandler}} +{{UpgradableProxyWithAdmin}} +{{Versionable}} diff --git a/contracts/types/README.adoc b/contracts/types/README.adoc new file mode 100644 index 000000000..8fcf3b992 --- /dev/null +++ b/contracts/types/README.adoc @@ -0,0 +1,26 @@ += Types + +Contains the types contracts. + +== Contracts + +{{AddressSet}} +{{Blocknumber}} +{{ChainId}} +{{ClaimId}} +{{DistributorType}} +{{Fee}} +{{Key32}} +{{NftIdSet}} +{{NftId}} +{{NumberId}} +{{ObjectType}} +{{PayoutId}} +{{Referral}} +{{RiskId}} +{{RoleId}} +{{Seconds}} +{{StateId}} +{{Timestamp}} +{{UFixed}} +{{Version}}