CreditClassInfo.yaml

id: https://framework.regen.network/schema/CreditClassInfo
name: CreditClassInfo
prefixes:
  linkml: https://w3id.org/linkml/
  rfs: https://framework.regen.network/schema/

imports:
  - linkml:types
  - core
  - taxonomy
  - Registry
  - Impact
  - Methodology
  - CreditProtocol
  - CreditingProgram

default_prefix: rfs
default_range: string

classes:
  CreditClassInfo:
    description: Base class with common fields used to define credit class info.
    slots:
      - name
      - description
      - url
    slot_usage:
      name:
        required: true
    attributes:
      hasPrimaryImpact:
        description: The primary impact expected from adhering to the protocol and/or management practices associated with the credit class. Generally speaking the quantifiable components of this impact are associated with the credit type that the credit class exists under (e.g. Carbon, Biodiversity, etc).
        range: Impact
        required: true
      hasCoBenefits:
        description: Co-benefits are any secondary impacts that may result from adhering to the protocol and/or management practices associated with the credit class. They can be qualitative or quantitative.
        range: Impact
        multivalued: true
      hasSourceRegistry:
        description: The registry where the credits are originally issued and tracked if somewhere other than Regen Network.
        range: Registry
      managedUnderProgram:
        description: The higher-level rules and requirements under which the given credit protocol operates, sometimes referred to as the "Standard".
        range: CreditingProgram
      creditProtocol:
        description: The root document of the credit protocol that defines the requirements and process to register and issue credits under a credit protocol. It could be registered under a program or independent. It could include methods to measure and monitor, or reference other methodology documents.
        range: CreditProtocol
      hasApprovedMethodologies:
        description: If one or more standalone methodologies for quantifying GHG or other benefits are approved for use, supplemental to any explicit methodlogies defined within the main creditProtocol document, they can be listed here.
        range: Methodology
        multivalued: true
      hasCreditingTerm:
        description: The total duration of the crediting term for the project.
        range: duration
      eligibleEnvironmentTypes:
        description: Types of environments that a project registered under this credit class may focuses on.
        range: EnvironmentType
        multivalued: true
      eligibleActivities:
        description: Eligible activities for projects registered under this credit class.
        range: ActivityType
        multivalued: true

  CarbonCreditClassInfo:
    is_a: CreditClassInfo
    description: Off-chain metadata representation for credit classes where the credit type is Carbon (C)
    attributes:
      hasPermanencePeriod:
        description: Permanence period of the credits.
        range: duration
      hasCreditGenerationMethod:
        description: Method for generating credits.
        range: CreditGenerationMethod

enums:
  CreditGenerationMethod:
    description: Enumeration of methods for generating credits in the carbon domain.
    permissible_values:
      AVOIDED_EMISSIONS:
        description: Credits generated by preventing the release of greenhouse gases into the atmosphere.
      CARBON_DIOXIDE_REMOVAL:
        description: Credits generated by processes that result in net removal of carbon dioxide from the atmosphere.
      EMISSIONS_REDUCTION:
        description: Credits generated by reducing the amount of greenhouse gases emitted compared to a baseline scenario.