OBJECT

EwaiInstance

Idenfification and configuration parameters about this specific EWAI Instance. EWAI-MARKET and EWAI-LISTEN use some of these settings to control their behavior.

link GraphQL Schema definition

  • type EwaiInstance {
  • # The EWAI instance name (which is always specified in EWNS format). @example
  • # 'market1.apps.exampleco.iam.ewc'
  • name: String!
  • # The EWAI API version identifier/prefix. @example 'v1'
  • apiVersion: String!
  • # The EW-Switchboard role which user DIDs much possess in order to create EWAI
  • # assets. @example 'assetpub.roles.market1.apps.exampleco.iam.ewc'
  • assetPublishRole: String!
  • # The EW-Switchboard URL that users need to visit to enroll in the
  • # assetPublishRole role. @example
  • # 'https://volta-switchboard.energyweb.org/#/enrol?app=market1.apps.exampleco.iam.ewc&roleName=assetpub'
  • assetPublishRoleEnrolUrl: String!
  • # Specifies whether or not the assetPublishRole check is enforced or not,
  • # typically only false for dev. @example true
  • enforceAssetPublishRole: Boolean!
  • # The EW-Switchboard role which DER DIDs much possess in order to send messages to
  • # EW-Messaging server. @example 'user.roles.messaging.apps.energyweb.iam.ewc'
  • messagingUserRole: String!
  • # The EW-Switchboard role which DER DIDs much possess in order to send messages to
  • # the EW-Messaging channel for this EWAI instance. @example
  • # 'datapub.roles.market1.apps.exampleco.iam.ewc'
  • ewaiMessagingChannelPublishRole: String!
  • # The EW-Switchboard URL that this EWAI instance is using. @example
  • # 'https://volta-switchboard.energyweb.org'
  • switchboardUrl: String!
  • # The base REST API URL for this EWAI instance. @example
  • # 'http://localhost:3001/ewai/v1'
  • restApiUrl: String!
  • # The base GraphQL API URL for this EWAI instance. @example
  • # 'http://localhost:3001/graphql'
  • graphQlUrl: String!
  • # The EnergyWeb EWC chain this EWAI instance is connected to. @example
  • # 'https://volta-rpc.energyweb.org'
  • ewcRpcUrl: String!
  • # The EnergyWeb EWC chain id that this EWAI instance is connected to. @example
  • # 73799
  • ewcChainId: Int!
  • # Whether or not Reset Data GraphQL calls are allowed on data assets. This is a
  • # fairly dangerous call, as it could wipe out months (or even years) worth of
  • # accumulated data if used improperly and without proper backups, hence it can be
  • # turned on or off. @example false
  • allowResetData: Boolean!
  • }

link Require by