modules.md

iam-client-lib

Table of contents

Enumerations

• AssetHistoryEventType
• ClaimEventType
• ERROR_MESSAGES
• ExecutionEnvironment
• MessagingMethod
• NamespaceType
• Order
• ProviderEvent
• ProviderType
• RegistrationTypes
• SearchType
• StakeStatus

Classes

• AssetsService
• CacheClient
• ChangeOwnershipNotPossibleError
• ClaimsService
• DeletingNamespaceNotPossibleError
• DidRegistry
• DomainsService
• ENSOwnerNotValidAddressError
• ENSTypeNotSupportedError
• EkcSigner
• MalformedDIDError
• MessagingService
• MethodNotAvailableInNodeEnvError
• SignerService
• StakingFactoryService
• StakingPool
• StakingPoolService
• StakingService

Interfaces

• Asset
• AssetHistory
• AssetProfile
• AssetProfiles
• CacheServerClientOptions
• ChainConfig
• Claim
• ClaimData
• IApp
• ICacheClient
• IClaimIssuance
• IClaimRejection
• IClaimRequest
• IMessage
• IOrganization
• IPubKeyAndIdentityToken
• IRole
• MessagingConfig
• Profile

Type aliases

• AccountInfo
• AssetsFilter
• ChainId
• ClaimsFilter
• IssueClaim
• RejectClaim
• RequestClaim
• Service
• ServiceInitializer
• Stake

Variables

• IS_ETH_SIGNER
• NODE_FIELDS_KEY
• PUBLIC_KEY
• TEST_LOGIN_ENDPOINT
• VOLTA_CHAIN_ID
• agreement_type_hash
• defaultAzureProxyUrl
• defaultBridgeUrl
• defaultClaimExpiry
• defaultKmsServerUrl
• didPattern
• emptyAddress
• erc712_type_hash
• proof_type_hash
• typedMsgPrefix

Functions

• addSupportedDID
• cacheConfigs
• chainConfigs
• compareDID
• createWalletConnectProvider
• executionEnvironment
• fromGnosis
• fromKms
• fromMetaMask
• fromPrivateKey
• fromWalletConnectMetamask
• getMessagingConfig
• init
• initWithEKC
• initWithGnosis
• initWithKms
• initWithMetamask
• initWithPrivateKeySigner
• initWithWalletConnect
• isMetamaskExtensionPresent
• isValidDID
• readyToBeRegisteredOnchain
• setCacheConfig
• setChainConfig
• setMessagingConfig
• supportedDIDMethods

Type aliases

AccountInfo

Ƭ AccountInfo: Object

Type declaration

Name	Type
account	string
chainId	number
chainName	string

---

AssetsFilter

Ƭ AssetsFilter: Object

Type declaration

Name	Type
order?	Order
skip?	number
take?	number
type?	AssetHistoryEventType

---

ChainId

Ƭ ChainId: number

---

ClaimsFilter

Ƭ ClaimsFilter: Object

Type declaration

Name	Type
isAccepted?	boolean
namespace?	string

---

IssueClaim

Ƭ IssueClaim: Object

Type declaration

Name	Type
issuer	string
message	IClaimIssuance

---

RejectClaim

Ƭ RejectClaim: Object

Type declaration

Name	Type
issuer	string
message	IClaimRejection

---

RequestClaim

Ƭ RequestClaim: Object

Type declaration

Name	Type
message	IClaimRequest
requester	string

---

Service

Ƭ Service: Object

Type declaration

Name	Type	Description
org	string	organization ENS name
pool	string	pool address
provider	string	provider address

---

ServiceInitializer

Ƭ ServiceInitializer: () => Promise<void>

Type declaration

▸ (): Promise<void>

Returns

Promise<void>

---

Stake

Ƭ Stake: Object

Type declaration

Name	Type
amount	BigNumber
depositEnd	BigNumber
depositStart	BigNumber
status	StakeStatus

Variables

IS_ETH_SIGNER

• IS_ETH_SIGNER: "isEthSigner"

---

NODE_FIELDS_KEY

• NODE_FIELDS_KEY: "metadata"

---

PUBLIC_KEY

• PUBLIC_KEY: "PublicKey"

---

TEST_LOGIN_ENDPOINT

• TEST_LOGIN_ENDPOINT: "/auth/status"

---

VOLTA_CHAIN_ID

• VOLTA_CHAIN_ID: 73799

---

agreement_type_hash

• agreement_type_hash: string

---

defaultAzureProxyUrl

• defaultAzureProxyUrl: "https://azure-proxy-server.energyweb.org/api/v1"

---

defaultBridgeUrl

• defaultBridgeUrl: "https://bridge.walletconnect.org"

---

defaultClaimExpiry

• defaultClaimExpiry: number

---

defaultKmsServerUrl

• defaultKmsServerUrl: "https://km.aws.energyweb.org/connect/new"

---

didPattern

• didPattern: "^(?:did:(?<method>[a-z0-9]+?):)((?<chain>[a-z0-9]+?):)?(?<id>0x[A-Fa-f0-9]{40})$"

---

emptyAddress

• emptyAddress: "0x0000000000000000000000000000000000000000"

---

erc712_type_hash

• erc712_type_hash: string

---

proof_type_hash

• proof_type_hash: string

---

typedMsgPrefix

• typedMsgPrefix: "1901"

Functions

addSupportedDID

▸ addSupportedDID(methodWithChain, validator): void

Parameters

Name	Type
methodWithChain	string
validator	(did: string) => boolean

Returns

void

---

cacheConfigs

▸ Const cacheConfigs(): Object

Returns

Object

---

chainConfigs

▸ Const chainConfigs(): Object

Returns

Object

---

compareDID

▸ compareDID(didA, didB): boolean

description For verification which envolves legacy and chain-specific DID's

Parameters

Name	Type
didA	string
didB	string

Returns

boolean

---

createWalletConnectProvider

▸ Const createWalletConnectProvider(bridge, infuraId?): WalletConnectProvider

Parameters

Name	Type
bridge	string
infuraId?	string

Returns

WalletConnectProvider

---

executionEnvironment

▸ Const executionEnvironment(): ExecutionEnvironment

Returns

ExecutionEnvironment

---

fromGnosis

▸ Const fromGnosis(safeAppSdk): Promise<SignerService>

description Intended for use in Volta Gnosis web interface(https://volta.gnosis-safe.io/). Dapp should provide SafeAppSdk injected by Gnosis interface

Parameters

Name	Type
safeAppSdk	SafeAppsSDK

Returns

Promise<SignerService>

---

fromKms

▸ fromKms(bridge, kmsServerUrl, infuraId?): Promise<SignerService>

Parameters

Name	Type
bridge	string
kmsServerUrl	string
infuraId?	string

Returns

Promise<SignerService>

---

fromMetaMask

▸ Const fromMetaMask(): Promise<SignerService>

Returns

Promise<SignerService>

---

fromPrivateKey

▸ Const fromPrivateKey(privateKey, rpcUrl): Promise<SignerService>

Parameters

Name	Type
privateKey	string
rpcUrl	string

Returns

Promise<SignerService>

---

fromWalletConnectMetamask

▸ Const fromWalletConnectMetamask(bridge, infuraId?): Promise<SignerService>

Parameters

Name	Type
bridge	string
infuraId?	string

Returns

Promise<SignerService>

---

getMessagingConfig

▸ Const getMessagingConfig(): Object

Returns

Object

---

init

▸ init(signerService): Promise<{ connectToCacheServer: () => Promise<{ assetsService: AssetsService ; cacheClient: CacheClient ; connectToDidRegistry: (ipfsStore?: string) => Promise<{ claimsService: ClaimsService ; didRegistry: DidRegistry }> ; domainsService: DomainsService ; stakingPoolService: null | StakingFactoryService ; stakingService: null | StakingService }> ; messagingService: MessagingService ; signerService: SignerService }>

Parameters

Name	Type
signerService	SignerService

Returns

Promise<{ connectToCacheServer: () => Promise<{ assetsService: AssetsService ; cacheClient: CacheClient ; connectToDidRegistry: (ipfsStore?: string) => Promise<{ claimsService: ClaimsService ; didRegistry: DidRegistry }> ; domainsService: DomainsService ; stakingPoolService: null | StakingFactoryService ; stakingService: null | StakingService }> ; messagingService: MessagingService ; signerService: SignerService }>

---

initWithEKC

▸ initWithEKC(proxyUrl?): Promise<{ connectToCacheServer: () => Promise<{ assetsService: AssetsService ; cacheClient: CacheClient ; connectToDidRegistry: (ipfsStore?: string) => Promise<{ claimsService: ClaimsService ; didRegistry: DidRegistry }> ; domainsService: DomainsService ; stakingPoolService: null | StakingFactoryService ; stakingService: null | StakingService }> ; messagingService: MessagingService ; signerService: SignerService }>

Parameters

Name	Type	Default value
proxyUrl	string	defaultAzureProxyUrl

Returns

Promise<{ connectToCacheServer: () => Promise<{ assetsService: AssetsService ; cacheClient: CacheClient ; connectToDidRegistry: (ipfsStore?: string) => Promise<{ claimsService: ClaimsService ; didRegistry: DidRegistry }> ; domainsService: DomainsService ; stakingPoolService: null | StakingFactoryService ; stakingService: null | StakingService }> ; messagingService: MessagingService ; signerService: SignerService }>

---

initWithGnosis

▸ initWithGnosis(safeAppSdk): Promise<{ connectToCacheServer: () => Promise<{ assetsService: AssetsService ; cacheClient: CacheClient ; connectToDidRegistry: (ipfsStore?: string) => Promise<{ claimsService: ClaimsService ; didRegistry: DidRegistry }> ; domainsService: DomainsService ; stakingPoolService: null | StakingFactoryService ; stakingService: null | StakingService }> ; messagingService: MessagingService ; signerService: SignerService }>

Parameters

Name	Type
safeAppSdk	SafeAppsSDK

Returns

Promise<{ connectToCacheServer: () => Promise<{ assetsService: AssetsService ; cacheClient: CacheClient ; connectToDidRegistry: (ipfsStore?: string) => Promise<{ claimsService: ClaimsService ; didRegistry: DidRegistry }> ; domainsService: DomainsService ; stakingPoolService: null | StakingFactoryService ; stakingService: null | StakingService }> ; messagingService: MessagingService ; signerService: SignerService }>

---

initWithKms

▸ initWithKms(__namedParameters?): Promise<{ connectToCacheServer: () => Promise<{ assetsService: AssetsService ; cacheClient: CacheClient ; connectToDidRegistry: (ipfsStore?: string) => Promise<{ claimsService: ClaimsService ; didRegistry: DidRegistry }> ; domainsService: DomainsService ; stakingPoolService: null | StakingFactoryService ; stakingService: null | StakingService }> ; messagingService: MessagingService ; signerService: SignerService }>

Parameters

Name	Type
__namedParameters	Object
__namedParameters.bridge	undefined | string
__namedParameters.kmsServerUrl	undefined | string

Returns

Promise<{ connectToCacheServer: () => Promise<{ assetsService: AssetsService ; cacheClient: CacheClient ; connectToDidRegistry: (ipfsStore?: string) => Promise<{ claimsService: ClaimsService ; didRegistry: DidRegistry }> ; domainsService: DomainsService ; stakingPoolService: null | StakingFactoryService ; stakingService: null | StakingService }> ; messagingService: MessagingService ; signerService: SignerService }>

---

initWithMetamask

▸ initWithMetamask(): Promise<{ connectToCacheServer: () => Promise<{ assetsService: AssetsService ; cacheClient: CacheClient ; connectToDidRegistry: (ipfsStore?: string) => Promise<{ claimsService: ClaimsService ; didRegistry: DidRegistry }> ; domainsService: DomainsService ; stakingPoolService: null | StakingFactoryService ; stakingService: null | StakingService }> ; messagingService: MessagingService ; signerService: SignerService }>

Returns

Promise<{ connectToCacheServer: () => Promise<{ assetsService: AssetsService ; cacheClient: CacheClient ; connectToDidRegistry: (ipfsStore?: string) => Promise<{ claimsService: ClaimsService ; didRegistry: DidRegistry }> ; domainsService: DomainsService ; stakingPoolService: null | StakingFactoryService ; stakingService: null | StakingService }> ; messagingService: MessagingService ; signerService: SignerService }>

---

initWithPrivateKeySigner

▸ initWithPrivateKeySigner(privateKey, rpcUrl): Promise<{ connectToCacheServer: () => Promise<{ assetsService: AssetsService ; cacheClient: CacheClient ; connectToDidRegistry: (ipfsStore?: string) => Promise<{ claimsService: ClaimsService ; didRegistry: DidRegistry }> ; domainsService: DomainsService ; stakingPoolService: null | StakingFactoryService ; stakingService: null | StakingService }> ; messagingService: MessagingService ; signerService: SignerService }>

Parameters

Name	Type
privateKey	string
rpcUrl	string

Returns

Promise<{ connectToCacheServer: () => Promise<{ assetsService: AssetsService ; cacheClient: CacheClient ; connectToDidRegistry: (ipfsStore?: string) => Promise<{ claimsService: ClaimsService ; didRegistry: DidRegistry }> ; domainsService: DomainsService ; stakingPoolService: null | StakingFactoryService ; stakingService: null | StakingService }> ; messagingService: MessagingService ; signerService: SignerService }>

---

initWithWalletConnect

▸ initWithWalletConnect(bridge?): Promise<{ connectToCacheServer: () => Promise<{ assetsService: AssetsService ; cacheClient: CacheClient ; connectToDidRegistry: (ipfsStore?: string) => Promise<{ claimsService: ClaimsService ; didRegistry: DidRegistry }> ; domainsService: DomainsService ; stakingPoolService: null | StakingFactoryService ; stakingService: null | StakingService }> ; messagingService: MessagingService ; signerService: SignerService }>

Parameters

Name	Type	Default value
bridge	string	defaultBridgeUrl

Returns

Promise<{ connectToCacheServer: () => Promise<{ assetsService: AssetsService ; cacheClient: CacheClient ; connectToDidRegistry: (ipfsStore?: string) => Promise<{ claimsService: ClaimsService ; didRegistry: DidRegistry }> ; domainsService: DomainsService ; stakingPoolService: null | StakingFactoryService ; stakingService: null | StakingService }> ; messagingService: MessagingService ; signerService: SignerService }>

---

isMetamaskExtensionPresent

▸ Const isMetamaskExtensionPresent(): Promise<{ chainId: undefined | number ; isMetamaskPresent: boolean = !!provider }>

Returns

Promise<{ chainId: undefined | number ; isMetamaskPresent: boolean = !!provider }>

---

isValidDID

▸ isValidDID(did): boolean

Parameters

Name	Type
did	string

Returns

boolean

---

readyToBeRegisteredOnchain

▸ Const readyToBeRegisteredOnchain(claim): claim is Required<Pick<Claim, "subjectAgreement" | "onChainProof" | "acceptedBy">>

Parameters

Name	Type
claim	object

Returns

claim is Required<Pick<Claim, "subjectAgreement" | "onChainProof" | "acceptedBy">>

---

setCacheConfig

▸ Const setCacheConfig(chainId, options): void

Used to override existing cache server configuration or add a missing one Configuration must be set before constructing IAM

Parameters

Name	Type
chainId	number
options	Partial<CacheServerClientOptions>

Returns

void

---

setChainConfig

▸ Const setChainConfig(chainId, config): void

Used to override existing chain configuration or add a missing one Configuration must be set before constructing IAM

Parameters

Name	Type
chainId	number
config	Partial<ChainConfig>

Returns

void

---

setMessagingConfig

▸ Const setMessagingConfig(chainId, options): void

Used to override existing messaging configuration or add a missing one Configuration must be set before constructing IAM

Parameters

Name	Type
chainId	number
options	Partial<MessagingConfig>

Returns

void

---

supportedDIDMethods

▸ supportedDIDMethods(): string[]

Returns

string[]