๐ŸŒด
Guardian-dev
  • Guardian
    • ๐ŸŒGetting Started
      • ๐Ÿœ๏ธDiscovering Environmental assets on Hedera
      • ๐ŸŽ“Guardian Glossary
      • ๐Ÿ“–Installation Guide
        • ๐Ÿ—’๏ธPrerequisites
        • ๐Ÿ› ๏ธInstallation
          • ๐Ÿ”จBuilding from source and run using Docker
            • Deploying Guardian using default Environment
            • Deploying Guardian using a specific Environment ( DEVELOP )
            • Deploying Guardian using a specific Environment (QA)
          • ๐Ÿ”จBuilding from Pre-build containers
          • ๐Ÿ”จBuild executables and run manually
          • โ˜๏ธCloud Deployment
          • โฌ†๏ธUpgrading
          • ๐Ÿ”™Backup tools
          • ๐ŸกSetting up environment parameters
          • ๐Ÿ“Summary of URLs and Ports
          • ๐Ÿ’ปLaunching Guardian
          • ๐ŸงชHow to perform Unit Tests?
        • ๐Ÿ”จHow to Configure Hedera Local Node
        • ๐Ÿ”จHow to Configure HashiCorp Vault
        • ๐Ÿ”จHow to create Operator ID and Operator Key
        • ๐Ÿ”จHow to generate Web3.Storage API values
        • ๐Ÿ”จHow to Change Explorer URL
        • ๐Ÿ”จHow to Restore Account from Database/Hashicorp Vault during Setup
      • ๐Ÿ™Contributing
        • ๐Ÿš‡Contribute a New Policy
      • ๐Ÿ“–Frameworks/Libraries
        • ๐Ÿ’ปGuardian CLI
      • โš™๏ธAPI Guideline
      • ๐Ÿ”Guardian Vault
      • ๐ŸŒŽEnvironments
        • ๐ŸŒŽMulti session consistency according to Environment
        • ๐Ÿ”‘Dynamic Vault/KMS path configuration according to the environment
        • ๐ŸกEcosystem Environments
      • ๐Ÿ“ƒChange Log
      • ๐Ÿ›ฃ๏ธRoadmap
      • ๐ŸšจLicense
      • ๐Ÿ“žContact
      • ๐Ÿ”Security
      • ๐Ÿ”‘Meeco authentication
        • ๐Ÿ”กHow it works
    • ๐Ÿ‘ทArchitecture
      • โฌ‡๏ธDeep Dive Architecture
      • ๐Ÿ”บHigh Level Architecture
      • ๐Ÿ‘Policies,Projects and Topics Mapping Architecture
      • โž—MRV Splitting Logic
      • ๐Ÿ”‘Internal (with Vault)Signing Sequence Diagram
      • ๐Ÿ”ฅFireBlocks Signing Sequence Diagram
    • ๐Ÿ“‡Global Indexer
      • ๐Ÿ’ปIndexer User Guide
      • โš™๏ธIndexer APIs
        • Full Text Indexer Search
        • Returns Standard Registries
        • Returns Registry as per MessageID
        • Returns Registry Users
        • Returns Registry User as per MessageID
        • Returns Policies
        • Returns policy as per MessageID
        • Returns Tools
        • Returns Tool as per MessageID
        • Returns Modules
        • Returns Module as per MessageID
        • Returns Schemas
        • Returns Schema as per MessageID
        • Returns Schema Tree
        • Returns Tokens
        • Returns Token as per TokenID
        • Returns Roles
        • Returns Role as per MessageID
        • Returns DIDs
        • Returns DID as per MessageID
        • Returns DID Relationships
        • Returns VP Documents
        • Returns VP Document as per MessageID
        • Returns VP Relationships
        • Returns VC Documents
        • Returns VC Document as per MessageID
        • Returns VC Relationships
        • Returns NFTs
        • Returns NFT as per Serial No.
        • Returns Topics
        • Returns Topic as per TopicID
        • Returns Contracts
        • Returns Contract as per MessageID
        • Returns Landing Page Analytics
        • Returns Project Coordinates
        • Returns Search Policy Results
        • Attempts to refresh linked files for the selected documents
        • Returns Hedera Network
        • Returns Hedera Network Explorer Settings
        • Returns Data Loading Progress Result
        • Returns Registry Relationships
        • Returns Policy Relationships
        • Retrieve the list of formulas
        • Retrieve the formula by message ID
        • Retrieve linked documents which are related to formula
        • Returning Topic Data Priority Loading Progress
        • Adding Topic Data Priority Loading
        • Adding Policy Data for Priority Loading
        • Adding Token Data for Priority Loading
        • Adding Document to Data Priority Loading
    • ๐Ÿ—บ๏ธMap Related APIs
      • Returning map API Key
      • Returning Sentinel API Key
    • ๐Ÿ—„๏ธStandard Registry
      • ๐Ÿ› ๏ธSchemas
        • ๐Ÿ“‚Available Schema Types
        • ๐Ÿ“‚Property Glossary
        • โ„น๏ธTypes of Schemas
        • โ„น๏ธSchema Versioning & Deprecation Policy
        • ๐Ÿ“นHow to design a Schema of a Methodology
        • ๐Ÿ’ปCreating Schema using UI
        • โš™๏ธSchema APIs
          • Listing of Schema
          • Publishing Schema based on Schema ID
          • Updating Schema
          • Deleting a Schema
          • Schema Preview from IPFS
          • Schema Preview from Zip
          • Export message IDs of Schema
          • Export Files from Schema
          • Creation of Schema related to the topic
          • Returns all Schemas related to the topic
          • Importing Zip file containing Schema
          • Importing Schema from IPFS
          • Returning Schema by SchemaID
        • โš™๏ธSystem Schema APIs
          • Returns Schema by Type
          • Creates New System Schema
          • Returns Schema by Username
          • Updates the Schema
          • Delete System Schema
          • Publishes the Schema
          • Schema Type
          • Returns Map API Key
        • โš™๏ธSchema APIs for Asynchronous Execution
          • Creation of Schema
          • Publishing Schema
          • Previews the Schema from IPFS
          • Importing Schema from IPFS
          • Importing Schema from .zip
        • ๐Ÿ“Schema Differentiation
          • ๐Ÿ’ปSchema Differentiation using UI
          • โš™๏ธSchema Differentiation APIs
            • Compare Schemas
            • Exports Schema Differentiation Results
        • ๐Ÿ“Example Data
          • ๐Ÿ’ปAdding Example data using UI
        • ๐Ÿ“‚Schema Tree
          • ๐Ÿ’ปSchema Tree UI
          • โš™๏ธAPI for Returning Schema Tree
        • ๐Ÿ“Tag Schema
          • ๐Ÿ’ปCreating Tag Schemas using UI
          • โš™๏ธSchema Tags APIs
            • Returning all Schema Tags
            • Creating new Schema Tag
            • Deleting Schema Tag
            • Updating Schema Tag
            • Publishing Schema
            • Returning list of published schemas
        • Schema Predefined Values using UI
        • Schema Rules
          • Defining Schema Rules using UI
          • APIs related to Schema Rules
            • Creation of the new schema rule
            • Retrieve the schema rules
            • Retrieve the configuration of the rule by its ID
            • Update the configuration of the rule with the corresponding ID
            • Delete the rule by its ID
            • Activate the rule with the specified ID
            • Deactivate the rule with the specified ID
            • List all the schemas and policy relevant to the rule with the specified ID
            • Retrieve all the data needed for evaluating the rules
            • Create a new rule from the file
            • Load the file and return its preview
            • Export the selected rule (by ID) into the file
      • ๐Ÿ› ๏ธPolicies
        • ๐ŸŽ“Policy Glossary
        • ๐Ÿ“Versioning and Deprecation Policy
          • โ„น๏ธPolicy Versioning & Deprecation Policy
          • โ„น๏ธAPI Versioning & Deprecation Policy
          • โ„น๏ธInternal APIs Versioning & Deprecation Policy
        • ๐Ÿ”ฉPolicy Creation
          • ๐Ÿ”„Available Policy Workflow Blocks
            • InterfaceContainerBlock
            • PolicyRolesBlock
            • InterfaceStepBlock
            • requestVCDocumentBlock
            • sendToGuardianBlock
            • reassigningBlock
            • InformationBlock
            • InterfaceDocumentsSourceBlock
            • paginationAddon
            • DocumentsSourceAddOn
            • filtersAddOnBlock
            • InterfaceActionBlock
            • externalDataBlock
            • retirementDocumentBlock
            • calculateContainerBlock & calculateMathAddOnBlock
            • reportBlock & reportItemBlock
            • switchBlock
            • aggregateDocumentBlock
            • TimerBlock
            • revokeBlock
            • setRelationshipsBlock
            • buttonBlock
            • documentValidatorBlock
            • tokenActionBlock
            • tokenConfirmationBlock
            • mintDocumentBlock
            • Events
            • groupManagerBlock
            • multiSignBlock
            • customLogicBlock
            • splitBlock
            • wipeDocumentBlock
            • Create Token Block
            • impactAddon
            • Http Request Block
            • historyAddon
            • selectiveAttributes Block
            • tagsManagerBlock
            • extractDataBlock
            • externalTopicBlock
            • messagesReportBlock
            • notificationBlock
            • Button Block Addon (buttonBlockAddon)
            • Dropdown Block Addon (dropdownBlockAddon)
            • Request Vc Document Block Addon (requestVcDocumentBlockAddon)
            • Data Transformation Addon
          • ๐Ÿ’ปCreating Policy using UI
          • ๐Ÿ’ปCreating a Policy through Policy Configurator
            • Getting Started with the Policy Workflows
            • Policy Workflow Step 1
            • Policy Workflow Step 2
            • Policy Workflow Step 3
            • Policy Workflow Step 4
            • Policy Workflow Step 5
            • Policy Workflow Step 6
            • Policy Workflow Step 7
            • Policy Workflow Step 8
            • Policy Workflow Step 9
            • Policy Workflow Step 10
            • Policy Workflow Step 11
            • Policy Workflow Step 12
            • Policy Workflow Step 13
            • Policy Workflow Step 14
            • Policy Workflow Step 15
            • Policy Workflow Step 16
            • Policy Workflow Step 17
            • Policy Workflow Step 18
            • Policy Workflow Step 19
            • Policy Workflow Step 20
            • Policy Workflow Step 21
            • Policy Workflow Step 22
            • Policy Workflow Step 23
            • Policy Workflow Step 24
            • Policy Workflow Step 25
            • Policy Workflow Wrap Up
          • โš™๏ธCreating a Policy using APIs
            • Prerequesite Steps
            • Creation of a Policy
            • Policy Listing
            • Import a Policy from IPFS
            • Policy Preview from IPFS
            • Retrieves Policy Configuration
            • Updates Policy Configuration
            • Publish a Policy
            • Policy Validation
            • Retrieval of Data for Root Policy Block
            • Request Block Data
            • Sends Data to Specified Block
            • Returns Block ID by tag
            • Exporting Message ID
            • Export to zip file
            • Import from zip file
            • Retrieves Block Data by Tag
            • Sends Data to specified Block by Tag
            • Returns list of Groups of a particular user
            • Make the selected Group active
            • Creating link between policies
            • Requesting Multi Policy Config
            • Importing Policy from a Zip file with Metadata
          • โš™๏ธAPIs for Asynchronous Execution
            • Creates new Policy
            • Publishing a Policy
            • Importing a Policy from IPFS
            • Importing a Policy from file
            • Policy Review
            • Importing Policy from a Zip file with Metadata
        • ๐Ÿ“Dry Run
          • ๐Ÿ’ปDry Run Mode using UI
          • โš™๏ธDry Run Mode using APIs
            • Running Policy without making any changes
            • Returning all Virtual Users
            • Creating Virtual Account
            • Logging Virtual User
            • Restarting the execution of Policy
            • Returns List of Transactions
            • Returns List of Artifacts
            • Returns List of IPFS Files
            • Returning Policy to Editing
            • Create Savepoint
            • Returns Savepoint State
            • Restoring SavePoint
            • Deletes SavePoint
        • ๐Ÿง‘โ€๐Ÿคโ€๐Ÿง‘Roles and Groups
          • ๐Ÿ’ปCreating Roles and Groups using Policy Configurator UI
        • ๐Ÿ“Record/Replay
          • ๐Ÿ’ปPolicy execution record and replay using UI
          • โš™๏ธRecord/Replay APIs
            • Get Recording
            • Start Recording
            • Stop Recording
            • Get Recorded Actions
            • Run record from zip file
            • Stop Running
            • Get Running Results
            • Get Running Details
            • Fast Forward
            • Retry Step
            • Skip Step
        • ๐Ÿ“Global Policy Search & Compare
          • ๐Ÿ’ปGlobal search and comparison UI
          • ๐Ÿ’ปPolicy Differentiation using UI
          • โš™๏ธPolicy Compare and Search APIs
            • Comparing Policies
            • Searching Policies
            • Exports Comparison results
        • ๐Ÿ”Block/Policy Discoverability
          • ๐Ÿ’ปSearch Policy using UI
          • โš™๏ธSearch Policy APIs
            • Search Policy
          • ๐Ÿ’ปSearch Block using UI
          • โš™๏ธSearch Block APIs
            • Searching Same Blocks
        • ๐Ÿ“‚Document Comparison
          • ๐Ÿ’ปDocument Comparison using UI
          • โš™๏ธDocument Comparison APIs
            • Compare Documents
            • Export Comparison Results
        • ๐Ÿ“‚Tools
          • ๐Ÿ’ปTools using UI
          • โš™๏ธTools APIs
            • Creating new Tool
            • Returns list of tools
            • Creating new tool asynchronously
            • Deletes the Tool
            • Retrieves Tool Configuration
            • Updates Tool Configuration
            • Publishes Tool onto IPFS
            • Publishes Tool into IPFS asynchronously
            • Validates Selected Tool
            • Returns Tools and its artifacts in zip format
            • Retrieves Hedera Message ID
            • Previews Imported Tool from IPFS
            • Imported Tool from IPFS
            • Previews Imported Tool from Zip
            • Importing Tool from Zip
            • Imports new tool from Zip Asynchronously
            • Imports new tool from IPFS Asynchronously
            • Returns List of Tools
            • Importing Tool from a Zip file
            • Importing Tool from a Zip file asynchronously
        • ๐Ÿ“Modules
          • ๐Ÿ’ปModules using UI
          • โš™๏ธModules APIs
            • Returns all Modules
            • Creating new Module
            • Returns Module Menu
            • Retrieves Module Configuration
            • Updates Module Configuration
            • Delete the Module
            • Publishing Module onto IPFS
            • Returns Hedera ID for specific Module
            • Exporting Module in zip format
            • Import Module from IPFS
            • Import module from zip file
            • Preview Module from IPFS
            • Preview Module from zip file
            • Validates Module
          • ๐Ÿ“Modules Differentiation
            • ๐Ÿ’ปModule Differentiation using UI
            • โš™๏ธModule Differentiation APIs
              • Returns result of Module Comparison
              • Exports Comparison Result
        • ๐Ÿ“Tagging
          • ๐Ÿ’ปTagging using UI
          • โš™๏ธTagging APIs
            • Creating Tag
            • Searching Tag
            • Deleting Tag
            • Synchronization of tags
        • ๐Ÿ“Themes
          • ๐Ÿ’ปThemes using UI
          • โš™๏ธThemes APIs
            • Returning all themes
            • Creating theme
            • Updating theme Configuration
            • Deleting theme
            • Returning zip file containing themes
            • Importing theme
        • ๐Ÿ“Policy Wizard
          • ๐Ÿ’ปDemo on Policy Wizard using UI
          • โš™๏ธPolicy Wizard APIs
            • Creating new Policy
            • Getting Policy Configuration
        • ๐Ÿ“‚Auto Suggestion
          • ๐Ÿ’ปDemo using UI
          • โš™๏ธAuto Suggestion APIs
            • Get next and nested suggested block types
            • Get suggestions configuration
            • Set suggestions configuration
        • ๐Ÿ“Auto Testing of the Policies
          • ๐Ÿ’ปAuto Testing using UI
          • โš™๏ธAuto Testing Policies APIs
            • Adding new Test to the policy
            • Returning Policy Test by ID
            • Running the Policy Test
            • Stopping the Specified Test
            • Deleting the Specified Test
            • Returning details of the most recent test run
        • ๐Ÿ“”Library of Policy Examples
          • ๐Ÿ’ปCreating and using Roles
          • ๐Ÿ”ขData input via Forms, using Roles to partition user activities.
          • ๐Ÿช™Token Operations
          • ๐Ÿ”ŽMRV Document Operations
          • โ›“๏ธTrustChain reports
          • โž—MRV aggregation and splitting for minting tokens
        • ๐Ÿ’ปDemo on Integrating external policies using UI
        • Policy Labels
          • Policy Labels UI
          • โš™๏ธAPIs related to Policy Labels
            • Creating new Label definition
            • Retrieve the list of Label definitions
            • Retrieve a label definition configuration by ID
            • Update Label configuration by ID
            • Delete Label definition by ID
            • Publish Label definition by ID
            • Publish Label definition by ID asynchronously
            • Retrieve the list of components for Label configuration (schemas, policies, etc)
            • Import Label configuration from a file
            • Export Label configuration to a file
            • Preview of the imported file
            • Search for Labels and Statistics for importing into Label configuration
            • Retrieve the list of created tokens (VPs) for which a Label document can be created
            • Retrieve token (VP) and all its dependencies by document ID
            • Create a new Label document for token (VP)
            • Retrieve a list of created Label documents
            • Retrieve Label document by ID
            • Retrieve linked Label documents by ID
        • Formula Linked Definitions
          • Formula Linked Definitions using UI
          • โš™๏ธAPIs related to Formula Linked
            • Creating a new formula
            • Returns a list of formulas
            • Returns a formula by its ID
            • Update the formula by its ID
            • Delete the formula by its ID
            • Retrieve the list of all schemas and policies linked to a Formula
            • Create a new formula (import) from a file
            • Export selected formulas into a file
            • Loads (import) a file and return its preview
            • Publish a formula
            • Retrieve all data from documents that needed for displaying the formula
      • ๐Ÿ”‘Bring your own DIDs
        • ๐Ÿ’ปBring your own (BYO) DIDs UI
        • โš™๏ธAPIs
          • Validate DID Format
          • Validate DID Keys
      • ๐Ÿ“Import/Export in Excel
        • ๐Ÿ’ปImport and Export Excel file User Guide
        • โš™๏ธImport/Export Schemas/Policies APIs
          • Import Schemas in Excel file format into a policy
          • Asynchronously Imports Schemas in Excel file format into a policy
          • Previews Schema from Excel file
          • Returns Schema in Excel file format
          • Returns list of Schemas
          • Exporting Policy to Excel
          • Import Schemas in Excel file format into a Policy
          • Asynchronously Imports Schemas in Excel file format into a policy
          • Policy Preview from Excel file
      • ๐Ÿ“Project Comparison
        • ๐Ÿ’ปProject Comparison using UI
        • โš™๏ธProject Comparison APIs
          • Comparing Project Data Documents
          • Comparing VP Documents - V1
          • Retrieves all Properties
          • Search Projects by filters
      • ๐Ÿ”‘Selective Disclosure
        • ๐Ÿ“”User Guide
        • ๐Ÿ”Selective Disclosure Demo
      • ๐Ÿ“ˆUsage Statistics
        • ๐Ÿ’ปStatistics
        • โš™๏ธAPIs related to Statistics
          • Returns the status of the current report
          • Update current report
          • Returns all reports
          • Returns report data by report uuid
          • Export report data in a csv file format
          • Export report data in a xlsx file format
          • Returns all dashboards
          • Returns dashboard by uuid
          • Returns Metrics
      • ๐Ÿ“’Artifacts
        • ๐Ÿ’ปImporting/Deleting Artifacts using UI
        • โš™๏ธArtifacts APIs
          • Returns all Artifacts
          • (deprecated) Returns all Artifacts
          • Upload Artifacts
          • (deprecated) Upload Artifacts
          • Delete Artifact
          • (deprecated) Delete Artifact
      • ๐Ÿ’ปAsynchronous Tasks Status
      • Show list of Hedera Transactions
        • Showing List of Hedera Transactions using
        • APIs
          • Returning all transactions for Policy
          • Returning all transactions for Schema
          • Returning all transactions for Token
          • Returning all transactions for Contract
      • ๐Ÿ””Notifications
        • ๐Ÿ’ปUser Guide
        • โš™๏ธAPIs related to Notification
          • Get All Notifications
          • Get new Notifications
          • Get Progresses
          • Read All Notifications
          • Delete Notifications
      • ๐Ÿ“Discontinuing Policy Workflow
        • ๐Ÿ’ปUser Guide
        • โš™๏ธAPIs related to Discontinuing Policy workflow
          • Discontinue Policy
          • MigratePolicy Data
          • Migrate Policy Data Asynchronous
          • Get Policy Documents
      • ๐Ÿ“Live Project Data Migration
        • โ†”๏ธLive Project Data Migration UI
        • โš™๏ธAPIs related to Live Project Data Migration
          • Getting Policy Data
          • Uploading Policy Data
          • Getting Policy Tag Block Map
          • Getting Policy Virtual Keys
          • Uploading Policy Virtual Keys
      • ๐Ÿ”ฅFireBlocks Raw Signing
        • Fireblocks signing in Guardian UI
        • Getting Keys from FireBlocks UI
      • ๐Ÿ™Roles & Permissions
        • ๐Ÿ’ปRoles and Permissions User Guide
        • โš™๏ธAPIs related to Roles & Permissions
          • Returns list of all permissions
          • Returns list of all roles
          • Creates a New Role
          • Updates Role Configuration
          • Deletes Role
          • Setting Default Role
          • Returns list of all users for whom the current user can change the role
          • Retrieves information about the user (roles, permissions assigned policies)
          • Updates User Roles (only SR)
          • Returns list of all Policies
          • Assigns Policies to a User - Only SR
          • Updates user roles (for ordinary uses)
          • Assigns policies to a user (for ordinary users)
      • Decentralized Guardian
        • Remote Policy UI
        • APIs
          • Returns the list of requests for adding remote policies
          • Previews the policy from IPFS without loading it into the local DB.
          • Policy Import from IPFS
          • Approves policy Asynchronously
          • Rejects policy Asynchronously
          • Approves Policy
          • Rejects policy
          • Return a list of all policies
          • Approves a request for an action from a remote Guardian
          • Rejects a request for an action from a remote Guardian
          • Return a count of policy requests
          • Returns the list of existing keys
          • Creates a new key
          • Deletes the key with the specified ID
      • Change Password
        • Password Security Hardening and Change Password using UI
        • โš™๏ธAPI related to Change Password
          • Change Password
      • ๐Ÿ“TrustChain
        • โš™๏ธTrustChain APIs
          • Requesting
          • Building and returning
      • ๐Ÿœ๏ธExternal Events
        • ๐Ÿ› ๏ธMonitoring Tools
          • โ›๏ธApplication-events module
        • โš™๏ธSend Data using the External Data APIs
          • Sends Data from an External Source
      • ๐Ÿ“ฑMobile Support for Data Interface
        • ๐Ÿ“ฑMobile operation for the Standard Registry
      • ๐Ÿ› ๏ธStandard Registry Operations
        • โš™๏ธSettings APIs
          • Displaying Current Settings
          • Adding Settings
        • โš™๏ธLogs APIs
          • Returning Logs
          • Returning Log Attributes
        • โš™๏ธTask Statuses APIs
          • Returning Task Statuses
      • ๐Ÿ“นDemo Experience
    • ๐ŸคตUsers
      • ๐Ÿ› ๏ธUser Operations
        • โš™๏ธAccount APIs
          • Authentication Process
          • User listing except Standard Registry and Auditor
          • User Balance
          • User Session
          • User Login
          • Registering new account
          • Returns all Standard Registries
          • Returns Access Token
        • Profile APIs
          • User Account Balance
          • User Account Information
          • Setting User Credentials
          • Setting User Credentials Asynchronously
      • ๐Ÿ“ฑMobile Support for Data Interface
        • ๐Ÿ“ฑMobile Operation for the user
      • ๐Ÿ› ๏ธUser Profile Setup
      • ๐Ÿค–AI Search
        • ๐Ÿ’ปAI Search using UI
        • โš™๏ธAI Search APIs
          • Returns response
          • Rebuilds vector based on policy data
      • ๐Ÿ”ŽGuided Search of Methodologies
        • ๐Ÿ’ปSearch using UI
        • โš™๏ธSearch APIs
          • Retrieves list of all categories
          • List of policies that are best suited for given parameters
      • โœ–๏ธMulti Policy
        • ๐Ÿ’ปConfiguring Multi Policy using UI
      • Bottom Up Data Traceability
        • Bottom Up Data Traceability using UI
        • โš™๏ธRelated APIs
          • Create new Statistics Definition
          • Get the list of Statistics Definitions
          • Retrieve details of the Statistics Definition by ID
          • Update configuration of the Statistics Definition by ID
          • Delete the Statistics Definition by ID
          • Publish Statistics Definition by ID
          • Retrieve the list of linked schemas and policy
          • Retrieve the list of all documents conforming the rules of the Statistics Definition.
          • Create a new Statistics Assessment based on the Statistics Definition
          • Retrieve the list of existing Statistics Assessment
          • Retrieve the Statistics Assessment by ID
          • Retrieve all VC documents related to the Statistics Assessment
    • ๐Ÿช™Tokens
      • ๐Ÿ’ปCreating Token using UI
      • ๐Ÿ“’Token Template
        • Creating Token Template using UI
        • Creating Token through UI using Token Template
      • ๐Ÿ“–Token Authenticity
        • โ„น๏ธEstablishing Token Authenticity
      • Dynamic Token Creation in Policies
        • Dynamic Token Creation in Guardian Policies using UI
      • ๐Ÿ› ๏ธToken Operations
        • โš™๏ธToken APIs
          • Token Listing
          • Creation of Token
          • User Info for selected token
          • Associates the user with token
          • Disassociates the user with token
          • Grants KYC for the user
          • Revoke KYC of the user
          • Freeze Tokens of a user
          • UnFreeze Tokens of a user
          • Returns Token Serials
        • โš™๏ธAPIs for Asynchronous Execution
          • Token Creation
          • Associating User with the Hedera Token
          • Disassociating User with the Hedera Token
          • Setting KYC for the User
          • Unsetting KYC for the User
      • ๐Ÿ“”Token Retirement Contract
        • ๐Ÿ’ปCreating Contract using UI
        • โ›“๏ธTrustChain representation of token retirement
        • โš™๏ธRetirement APIs
          • Returning all contracts
          • Creating new Contract
          • Importing new Contract
          • Get Contract Permissions
          • Removing Contract
          • Returns a list of all Wipe requests
          • Enabling Wipe Requests
          • Disabling Wipe Requests
          • Approving Wipe Requests
          • Rejecting Wipe Requests
          • Clearing Wipe Requests
          • Adding Wipe Admin
          • Removing Wipe Admin
          • Adding Wipe Manager
          • Removing Wipe Manager
          • Adding Wipe Wiper
          • Removing Wipe Wiper
          • Syncing Retire Pools
          • Returning list of all Retire Requests
          • Returning list of all Retire Pools
          • Deleting Retire Requests
          • Deleting Retire Pools
          • Setting Retire Pools
          • Unsetting Retire Pool
          • Unsetting Retire Request
          • Retiring Tokens
          • Approving Retire Request
          • Cancelling Retire Request
          • Adding Retire Admin
          • Removing Retire Admin
          • Returning all Retired VCs
          • Adding Wipe for specific token
          • Remove Wipe request for specific token
          • Deleting Wipe request for Hedera Account
          • Get Retirement VCs from Indexer
    • ๐Ÿ‘พAutomation Testing
      • ๐Ÿ’ปPerforming API Automation Testing
      • ๐Ÿ’ปPerforming UI Automation Testing
    • ๐Ÿ“•Logging Configuration using Pino Library
    • ๐Ÿ“”Guidance for Open Source Policy Submissions
    • ๐Ÿ“Demo Guide
      • ๐Ÿ”‹Renewable Energy Credits
        • ๐Ÿ“–Introduction to International Renewable Energy Credit Standard (iREC)
        • โš™๏ธiREC API Demo Guide
        • โš™๏ธDemo Using APIs and UI
        • ๐Ÿ’ปiREC 5 Demo UI Guide
        • โš™๏ธiREC 5 json
        • ๐Ÿ’ปiREC 7 User Journey UI Demo Guide
        • ๐Ÿ’ปiREC 7 Demo UI Guide
      • โ˜˜๏ธCarbon Offsets
        • ๐Ÿ“–Introduction to Verra Redd+
        • ๐Ÿ’ปVerra Redd VM0007 Demo UI Guide
        • ๐Ÿ’ปVerra Redd_3 User Journey Demo UI Guide
        • ๐ŸŽVM0017 Adoption of Sustainable Agricultural Land Management, v1.0
        • ๐ŸŽVM0042 Methodology for Improved Agricultural Land Management
        • ๐ŸŒฒVerra VM0047 - Afforestation, Reforestation, and Revegetation (ARR) v0.1
        • ๐ŸŒฒGold Standard Afforestation and Reforestation (AR) v2.0
        • ๐ŸƒDovu Methodologies
        • ๐Ÿ€Dovu MMCM
        • โ™จ๏ธImproved Cookstove
        • โ™จ๏ธGoldStandard - Metered Energy Cooking
        • ๐Ÿ€Carbon Reduction Measurement - GHG Corporate Standard Policy Guid
        • ๐ŸขVM0044 Methodology for Biochar Utilization in Soil and Non-Soil Applications
        • ๐ŸญCDM AMS-III.AR : Substituting fossil fuel based lighting with LED/CFL lighting systems
        • ๐ŸจCDM AMS II.G: Energy Efficiency Measures in Thermal Applications of Non-Renewable Biomass
        • ๐ŸญCDM AMS III.D: Methane Recovery in Animal Manure Management Systems
        • ๐ŸญCDM AMS III.BB: Electrification of communities through grid extension
        • ๐ŸญCDM AR-ACM0003: Methodology for Afforestation and Reforestation of Lands Except Wetlands
        • ๐ŸญCDM ACM0001: Flaring or Use of Landfill Gas
        • ๐ŸญCDM ACM0002: Grid-Connected Electricity Generation from Renewable Sources
        • ๐ŸญCDM ACM0006: Electricity and Heat Generation from Biomass
        • ๐ŸขCDM ACM0007: Conversion from Single Cycle to Combined Cycle Power Generation
        • ๐ŸญCDM AMS-I.A.: Electricity Generation by the User
        • ๐ŸญCDM AMS-I.C.: Thermal Energy Production with or Without Electricity
        • ๐ŸจCDM AMS-I.F.: Renewable Electricity Generation for Captive Use and Mini-Grid
        • ๐ŸญCDM AMS-II.J.: Demand-Side Activities for Efficient Lighting Technologies
        • ๐ŸจCDM AMS-III.AV.: Low Greenhouse Gas Emitting Safe Drinking Water Production Systems
        • ๐ŸญCDM AMS-III.F.: Avoidance of Methane Emissions Through Composting
        • ๐ŸขCDM AMS-III.H.: Methane Recovery in Wastewater Treatment
        • ๐ŸญCDM ACM0018: Electricity Generation from Biomass in Power-Only Plants
        • โฌ‡๏ธVerra PWRM0001 :Plastic Waste Collection Methodology
        • ๐ŸญVM0041 Methodology for the Reduction of Enteric Methane Emissions from Ruminants through the Use of
        • ๐Ÿฅ‡Carbon Sequestration through Accelerated Carbonation of Concrete Aggregate
        • ๐ŸญAMS-I.D: Grid Connected Renewable Electricity Generation โ€“ v.18.0
        • ๐ŸญPWRM0002 : Plastic Waste Recycling Methodology
        • ๐ŸšMethane Emission Reduction by Adjusted Water Management Practice in Rice Cultivation
        • โ›ฝVerra VMR0006: Energy Efficiency and Fuel Switch Measures in Thermal Applications
        • ๐ŸŒฉ๏ธAMS-I.E Switch from Non-Renewable Biomass for Thermal Applications by the User
        • GCCM001 v.4 Methodology for Renewable Energy Generation Projects Supplying Electricity to Grid
        • Landfill Gas Destruction and Beneficial Use Projects, Version 2.0
        • Climate Action Reserveโ€™s U.S. Landfill Protocol Version 6.0
        • VM0042 Improved Agricultural Land Management, v2.1
      • ๐ŸญCarbon Emissions
        • ๐ŸกRemote Work GHG Policy
          • ๐Ÿ“–Introduction to Remote Work GHG
          • ๐Ÿ’ปGHG Policy User Journey UI Demo Guide
          • ๐Ÿ’ปRemote GHG Policy Demo Guide
        • ๐ŸขCarbon Emissions Measurement - GHG Corporate Standard Policy Guide
        • ๐Ÿญatma GHG Scope II Carbon Emission Policy
        • ๐ŸญAtma Scope 3 GHG Policy
        • ๐ŸญGHGP Corporate Standard
        • ๐ŸญGHGP Corporate Standard V2
        • Climate Action Reserveโ€™s U.S. Landfill Protocol Version 6.0
        • Landfill Gas Destruction and Beneficial Use Projects, Version 2.0
    • โ“FAQs
    • ๐Ÿ‘ฌCommunity Standards
      • Guardian Policy Standards (GPS)
      • Guardian System Standards (GSS)
      • Proposal for Defining Standards
  • Feedback
    • Feedback in Pipelines
  • ๐Ÿ“ˆGuardian in Production
    • ๐Ÿ“„API Architecture Customization
    • ๐Ÿ“‰Monitoring tools
    • Performance Improvement
    • Cloud Infrastructure
    • Independent Packaged Deployment
Powered by GitBook
On this page
  • Table of content
  • Introduction
  • Why ME&ED(Metered and Measured Energy) Methodology?
  • Demo Video
  • Policy Workflow
  • Policy Guide
  • Future proofing(Automated credit issuance)
  • TODO
  • Existing Cookstove Policy Comparison
  1. Guardian
  2. Demo Guide
  3. Carbon Offsets

GoldStandard - Metered Energy Cooking

Policy developed by Gautam Prajapati during the SBS Hackathon

Last updated 6 months ago

Table of content

Introduction

According to the 2021 State of the Voluntary Carbon Markets report by Ecosystem Marketplace, improved cookstoves were the second most popular project type in the voluntary carbon market in 2020, accounting for 13% of all carbon offsets transacted. In 2020, cookstove projects generated over 13 million carbon offsets, with an estimated value of $48.6 million USD. The report notes that cookstove projects continue to be popular due to their multiple co-benefits, including improved health outcomes, reduced fuel consumption, and reduced deforestation.

This Guardian Policy tokenizes the VER(verified emission reduction) after verifying emissions reductions from improved cookstove projects according to Gold standard's methodology for Metered & Measured Energy Cooking Devices (ME&ED). The methodology is based on the use of energy meters and temperature sensors to collect data on the energy consumption and thermal efficiency of cookstoves, which is then used to calculate the emissions reductions achieved.

Why ME&ED(Metered and Measured Energy) Methodology?

Carbon offsets from improved cookstove projects help advance Sustainable Development Goals 13 (climate), 7 (energy), 5 (gender), and 3 (health). However, for the carbon offsets generated from these projects to be considered legitimate, methodologies must provide accurate or conservative measurements of the climate impact of these projects.

There are a bunch of improved cookstove methodologies to choose from -

Demo Video

Policy Workflow

Policy Guide

This policy is published to Hedera network and can either be imported via Github(.policy file) or IPFS timestamp.

Available Roles

  • Project Proponent - Project developer who proposes and executes cookstove project and receives credits(VER)

  • VVB(Validation & Verification Body) - Independent third party who audits project's critical documentation and monitoring reports

  • Gold Standard(GS) - GS is the trusted registry overseeing the entire project cycle and issuing the credits(VER)

Important Documents & Schemas

  1. Registry Account Application(RAA) - Account applications to become a project proponent, VVB with registry

  2. Project Inception Document (PID) - Preliminary design of project highlighting eligibility, additionality and methodology criteria along with stakeholder consultation report

  3. Project Design Document (PDD) - Submitted after PID is approved, detailed report on project execution, emissions calculations and sustainable development goals.

  4. Monitoring Report (MR) - Monitoring report contains analysis on cookstove usages on the sample group and estimates carbon avoided/reduced

  5. VER Credit Request(VCR) - Requesting specified number of credits into Hedera account

  6. Measuring Device - Registering a stove usage IOT device alongside the cookstove for automatic MRs

  7. VER Auto Credit Request(VACR) - Requesting automated issuance of credits based on data sent by a measuring device

Token(Carbon credit)

Verified Emission Reduction(VER) equivalent to 1 ton of CO2 offset

Step By Step

Registry(Gold Standard) Flow

Registry is allowed to publish and edit policy config, schemas, tokens and all the workflow logic associated with it. They are responsible for approving projects, project proponents, VVBs, and credit issue requests.

  1. Login into the service using registry credentials

  1. Feel free to play around with policy config by clicking on edit icon and understanding the different schemas used by policy

  1. Registry can review account applications by clicking manage accounts

  1. Registry can review project inception documents allowing the listing of projects on standard website and trigger project execution on ground.

  1. Once PDD and MR are approved by VVB, project proponents can submit credit issue requests(VER) which registries have to take decisions on.

  1. Once VER issue request is approved, an end-to-end trust chain can be viewed by administrator. Since everything is happening transparently on public ledger(Hedera), anyone can trace the source of credits and each step that happened in the process.

Project Proponent Flow

  1. Complete the sign up form(RAA) to become a project proponent

  1. Wait till the application is approved by the registry admin. Once approved, proponents will be able to submit project inception documents. This includes stakeholder consultation report as well.

  1. Once project is approved by registry, a detailed PDD(project design document) needs to be submitted. This is the most important document highlighting the technical details of project. It includes calculations around baseline, project and leakage scenarios for accurate calculation of avoided emissions.

  1. After PDD approval, project proponent will execute the project on ground and submit regular monitoring reports(MR)

  1. Once a monitoring report is approved by VVB, project proponent can request corresponding carbon credits(VER in this case) to be credited in their account. It would need a VC document ID for both monitoring report and it's approved review by VVB.

  1. Once registry reviews and approves the credit request, they'll be credited into the hedera account provided by project proponent. This is represented by successful minted status.

VVB Flow

VVB is the external independent third party responsible for reviewing Project Design Documents and Monitoring reports submitted by proponents. They can comment and reject/request changes as well.

  1. After logging in as VVB, they can view review requests related to project documents. First step is to review PDDs submitted by project proponents.

  1. After PDD approval, proponents will be able to send monitoring reports for review. Once approved, project proponents will be able to claim corresponding VERs.

Future proofing(Automated credit issuance)

This workflow includes a bonus flow which is a major distinction from other existing policies. Building monitoring reports for cookstove projects is a very manual and error-prone process due to distributed nature of project. Often, a sample group of households are selected to be monitored and results are extrapolated for all the households(in thousands) leading to overcrediting. Since this methodology focuses on having direct measurement devices associated with a stove, an automated way of monitoring is possible.

  1. Project proponent can register a measuring device associated a given cookstove

  1. Device can be approved/rejected by the VVB

  1. Once approved, project developer can raise on-demand credit issuance associated with approved devices. These requests would contain stove fuel usage and temperature data collected automatically by the device

  1. After an approval from VVB for the automated monitoring report, VER mint will be initiated in owner account. This will help in faster crediting cycles along with a transparent process for tracking all the intermediate steps. It'll be a huge boost to scaling up the supply of credits in VCM(Voluntary carbon markets).

TODO

[ ] Improve and document list column names for each of the roles, some review IDs are coming as null [ ] Improve all the schemas(especially PID, PDD). Add support for dynamically selecting fields on basis of fossil fuel or electric device [ ] Automate emissions calculations on basis of incoming parameters of equations from schemas [ ] Add Guardian support for list data type in schemas. Helpful for use cases where we're sending device usage data regularly via an API [ ] Thoroughly test and improve the future proofing IOT device workflow, there are dummy checks and thresholds currently. Schemas need to be updated to accept list of usage parameters.

Existing Cookstove Policy Comparison

Features
ME & ED
Improved Cookstove

Follows VCM industry project cycle and terminologies(Verra, Gold Standard)

Yes

No

Substantial over crediting possible

No

Yes

Critical metrics tracked directly in VC document - Additionality criteria | Baseline emissions calculation | Project emissions calculation | Leakage emissions

Yes | Yes | Yes | Yes

No | No | No | No

IOT based monitoring & automated credit issuance

Yes

No

Scalable according to future credits demand

Yes

No

Exhaustive documentation

Yes

No(incomplete)

According to more than 3 billion people lack access to clean cooking solutions leading to over 4 million premature deaths each year. This doesn't attribute the havoc GHG emissions from wood or fossil fuel based cookstoves are going to cause in the future.

Recently, a striking by The Guardian (media group) exposed the flaws in Verra's REDD+ scheme leading them to their methodologies. Such exposures dwindle the stakeholder's sentiment in the carbon markets and hence it is extremely important to build and choose right methodology for carbon projects.

According to a new from scholars of University of California, Berkeley - Gold Standardโ€™s Metered and Measured methodology, which directly monitors fuel use, is most aligned with the estimates (only 1.3 times over-credited) and is best suited for fuel switching projects which provide the most abatement potential and health benefit.

This approach is more precise than traditional methodologies, which rely on more generalized assumptions or estimates to calculate emissions reductions. It also places a strong emphasis on stakeholder engagement and the inclusion of local communities in the project development and monitoring process. This approach promotes greater transparency and accountability and helps to ensure that the environmental and social benefits of the project are maximized. This Guardian policy, is a reflection of same methodology according to the .

Latest Version - 0.0.3 Hedera Topic -

This policy was created during a hackathon so there may be couple of bugs here and there and it may not be foolproof. Here are some todos to make it production ready. You can reach out to the policy for reviewing or reporting issues relevant to this specific policy.

Latest version of Guardian provides a policy for . This new Guardian policy builds on top of it to make it more robust, aligned and future-proof. on differences using policy compare feature provided by Guardian.

๐Ÿ“
โ˜˜๏ธ
โ™จ๏ธ
Gold Standard
report
phase out
GS-TPDDTEC
GS-Simplified
CDM-AMS-II-G
CDM-AMS-I-E
GS-Metered-Energy
research
Gold standard's typical project lifecycle
Youtube
0.0.3972127
author/contributor
improved cookstoves
Here's a section in demo video
Why ME&ED(Metered and Measured Energy) Methodology?
Demo Video
Policy Workflow
Policy Guide
Available Roles
Important Documents & Schemas
Token(Carbon credit)
Step By Step
Registry(Gold Standard) Flow
Project Proponent Flow
VVB Flow
Futureproofing(Automated credit issuance)
TODO
Existing Cookstove Policy Comparison
Table of content
Introduction