githubEdit

💻Demo using UI

Step By Step

Demo

Step By Step

1. Overview

Relayer accounts are Hedera accounts designated to execute on-chain transactions associated with specific policy subflows during runtime.

They are typically used to isolate and organize on-chain activities across multiple projects. This separation allows different Hedera accounts to be assigned for financing and executing blockchain operations - such as posting messages, minting tokens, or performing other policy-driven actions - within the context of distinct projects.

1.1 Creation

Users can add Relayer Accounts using the corresponding button on their profile page.

To add an existing account, the account name, the Hedera account ID, and its private key must be provided.

It is also possible to create a new Hedera account and set it up as one of the relayer account for the user.

circle-info

Note 1: hbar balance of the new account would be 0 and would need to be toped-up (externally to Guardian) for the account to become useable.

circle-info

Note 2: make sure that the private key of the generated account is securely saved somewhere. Guardian does not have facilities to recover the lost key.

1.2 Configuration

To enable Guardian users to use Relayer Accounts when executing policy workflow, the policy must have ‘Set Relayer Account’ option switched on in the corresponding requestVcDocumentBlock, for example that which is responsible for project document.


All linked documents will inherit parent’s Relayer Account, there is no need to configure this setting for each of them specifically. I.e. it is only required to be set for the main (i.e. project) document.

When ‘Set Relayer Account’ option is selected in a policy block, at the execution time all other policy blocks performing transactions on Hedera (such as publishing documents) would be using parent document owner’s Hedera account for financing such transactions if it has been specified earlier in the workflow.

Force User Account’ option allows the change default downstream behaviour for when ‘Set Relayer Account’ is selected.

  • ‘Pre-set user account’ - the block will use parent document owner’s Hedera account regardless of current user context.

  • ‘Current user account’ - the block will user current user’s account regardless of other settings and parent document owner’s account configurations.

1.3 Usage

For policies with enabled ‘Relayer Accounts’ option users will be presented with the options to select account options

  1. User account – default behaviour backward compatible with previous Guardian versions. In this configuration individual user accounts will be used for each operation on Hedera corresponding to the user performing them.

  1. Existing relayer account – users can add one of previously added Relayer Accounts.

  1. New relayer account – the account can be added directly from this form.

circle-info

Note: Make sure the selected account is funded, the account has hbar balance sufficient to finance on-chain operations required by the policy workflows.

2. Viewing

2.1 Document to account associations

Document view shows which Relayer Account is associated with it.

2.2 Standard Registry (SR) functionality

Standard Registry can view all Relayer Accounts and balances for all users operating in its domain.

3. Tokens

Unless the policy is configured to send minted tokens to a specific account, tokens minted under Relayer Account configuration will be sent to the Relayer Account associated with the VC document on the basis of which the mint operation has been triggered.

Demo Video

Youtubearrow-up-right

Last updated

Was this helpful?