init.md

Module: init

Table of contents

Functions

• init
• initWithEKC
• initWithGnosis
• initWithKms
• initWithMetamask
• initWithPrivateKeySigner
• initWithWalletConnect

Functions

init

▸ init(signerService): Promise<{ connectToCacheServer: () => Promise<{ assetsService: AssetsService ; cacheClient: CacheClient ; connectToDidRegistry: (ipfsStore?: string) => Promise<{ claimsService: ClaimsService ; didRegistry: DidRegistry }> ; domainsService: DomainsService ; stakingPoolService: null | StakingFactoryService ; verifiableCredentialsService: VerifiableCredentialsServiceBase }> ; 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 ; verifiableCredentialsService: VerifiableCredentialsServiceBase }> ; 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 ; verifiableCredentialsService: VerifiableCredentialsServiceBase }> ; 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 ; verifiableCredentialsService: VerifiableCredentialsServiceBase }> ; 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 ; verifiableCredentialsService: VerifiableCredentialsServiceBase }> ; 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 ; verifiableCredentialsService: VerifiableCredentialsServiceBase }> ; 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 ; verifiableCredentialsService: VerifiableCredentialsServiceBase }> ; 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 ; verifiableCredentialsService: VerifiableCredentialsServiceBase }> ; 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 ; verifiableCredentialsService: VerifiableCredentialsServiceBase }> ; 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 ; verifiableCredentialsService: VerifiableCredentialsServiceBase }> ; 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 ; verifiableCredentialsService: VerifiableCredentialsServiceBase }> ; 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 ; verifiableCredentialsService: VerifiableCredentialsServiceBase }> ; 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 ; verifiableCredentialsService: VerifiableCredentialsServiceBase }> ; 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 ; verifiableCredentialsService: VerifiableCredentialsServiceBase }> ; messagingService: MessagingService ; signerService: SignerService }>