Interface
Fund Contract
| Name | Type | Description |
|---|---|---|
| name | string | Name of fund |
| description | string | A description of the fund |
| capitalCommitment | float | Sum of capital commitments from the contributorList’s |
| status | string | contractLifecycle status field |
| currency | object | The base currency of the fund; #ref Currency |
| versions | object[] | A list of previous versions of current contract |
| executeWindow | Duration | Represents the lifetime of the fund, defined with an ISO 8601 Duration string e.g. P30D denotes a period of 30 days. |
| executeEnd | string | executeEnd defines how to calculate the time to transition from EXECUTE to FINALIZE |
| executeBegin | Timestamp | A defined time to begin execution of the contract. If undefined or Timestamp is in the past then contract will initiate executaion immediately. |
| executedAt | Timestamp | The exact time when contract was executed |
| contributorAccess | string | contributorAccess defines how open the fund are for subscriptions and donations |
| contributorMinContribution | float | The minimum investment or donation allowed. |
| contributorRestrict | object[] | NOT IMPLEMENTED |
| finalizeAt | Timestamp | The computed time when finalize should accour if no other events defined comes before this. |
| finalizeProceeds | string | finalizeProceeds defines how remaining funds are treated. |
| finalizeProceedsForwardAdd | string | An alias, address, or fund did linked to a network wallet, to be used when funds are not returned at the end of the fund’s lifetime. |
| allocationInstrument | string | The allocationInstrument is the instruments available for allocating funds. |
| allocationMethod | string | The allocationMethod defines how allocations are triggered. |
| allocationFundeeType | string | allocationFundeeType Determines the type of fundee (e.g., individual, organization) eligible for the allocation. |
| allocationClaimWindow | Duration | The duration after which an unclaimed allocation will expire. |
| allocationConditionType | string | allocationConditionType Determines the conditions to apply. |
| allocationConditionWindow | Duration | A duration related to the allocationConditionType |
| allocationConditionGracePeriod | Duration | A duration before the allocationConditionWindow is used |
| allocationConditionAlgo | string | the allocationConditionAlgo is an algorithm to apply on allocationConditions |
| allocationConditionDescription | string | A description of the allocationConditions |
contractLifecycle states
| Value | Description |
|---|---|
| CREATE | The initial stage where the contract is conceptualized and designed. |
| FREEZE | Contract is halted and awaiting certian condition or verification. This is also the first state when the contract are deployed. |
| EXECUTE | Contract is currently active and operational. |
| PAUSED | Contract is paused, often indicating a temporary stoppage for maintenance or other reasons. |
| FINALIZE | Contract is nearing its end of life and going through final calculations, distributions, or other end-of-life processes. |
| COMPLETED | Contract has finished its intended execution and is now completed. |
| DEPRECATED | Contract is no longer in use or supported, often indicating it’s been replaced by a newer version. |
executeEnd types
| Value | Description |
|---|---|
| EXACT | Contract will transition from EXECUTE to FINALIZE at our shortly after the time determined by adding the duration specified in executePeriod to the executedAt timestamp. |
| END_OF_RESERVES | Contract will transition from EXECUTE to FINALIZE at the same time as EXACT or when the attached wallet runs out of funds, whichever happens first. The wallet’s reserves are reviewed at every allocation event. |
contributorAccess types
| Value | Description |
|---|---|
| PRIVATE | This is the most restricted access level. Contributor has to be by direct selected by the fund manager or through meeting specific criteria defined in the contract. Contributor typically need to have owner or write access to interact with the fund. |
| INVITE | Access is more controlled. The fund manager can directly invite contributors to invest or donate, or contributors can request access, but their participation depends on approval through the fund manager or an automated process defined in the contract. |
| PUBLIC | The fund is open for contributors from the public. Any participant that meets the basic regulatory or contract-defined criteria can invest or donate. |
allocationInstrument types
| Value | Description |
|---|---|
| GRANT | Funds are provided as a Grant |
allocationMethod types
| Value | Description |
|---|---|
| AUTOMATED | Allocations are performed automatically based on a predefined set of criteria using a distribution algorithm. |
| COMMITTEE | NOT IMPLEMENTED Allocations are determined by a committee, which is a group of entities that collectively decide and agree upon the allocation decisions. |
allocationFundee types
| Value | Description |
|---|---|
| Person | A naturel person |
| Organisation | NOT IMPLEMENTED An entity defined as a Organisation |
allocationCondition types
| Value | Description |
|---|---|
| DECAY | Allocated fund will decay over time. |
allocationConditionAlgo types
| Value | Description |
|---|---|
| LINEAR | - |
| PROGRESSING | - |
finalizeProceeds types
| Value | Description |
|---|---|
| FORWARD | Forward to a predefined wallet or fund. |
| RETURN | The proceeds are returned to the original contributors. |
| RECYCLE | The fund is either extended, or a new fund with a similar purpose is created starting afresh. |