Class YlideCore

Hierarchy

YlideCore

Constructors

constructor

new YlideCore(ylide: Ylide, controllers: YlideControllers, keysRegistry: YlideKeysRegistry, indexerBlockchains?: string[], useWebSocketPulling?: boolean): YlideCore
Parameters
- ylide: Ylide
- controllers: YlideControllers
- keysRegistry: YlideKeysRegistry
- indexerBlockchains: string[] = []
- Optional useWebSocketPulling: boolean
Returns YlideCore
- Defined in src/core/YlideCore.ts:63

Properties

`Readonly` controllers

controllers: YlideControllers

`Readonly` indexer

indexer: IndexerHub

`Private` `Readonly` indexerBlockchains

indexerBlockchains: string[] = []

`Readonly` keysRegistry

keysRegistry: YlideKeysRegistry

`Readonly` ylide

ylide: Ylide

Methods

broadcastMessage

broadcastMessage(__namedParameters: BroadcastMessageArgs, walletOptions?: any): Promise<SendBroadcastResult>
Parameters
- __namedParameters: BroadcastMessageArgs
- Optional walletOptions: any
Returns Promise<SendBroadcastResult>
- Defined in src/core/YlideCore.ts:536

decryptBroadcastContent

decryptBroadcastContent(msg: IMessage<any>, content: IMessageContent): {
    container: IUnpackedMessageContainer;
    content: MessageContentV3 | MessageContentV4 | MessageContentV5;
    serviceCode: ServiceCode;
}
Parameters
- msg: IMessage<any>
- content: IMessageContent
Returns {
    container: IUnpackedMessageContainer;
    content: MessageContentV3 | MessageContentV4 | MessageContentV5;
    serviceCode: ServiceCode;
}
- container: IUnpackedMessageContainer
- content: MessageContentV3 | MessageContentV4 | MessageContentV5
- serviceCode: ServiceCode
- Defined in src/core/YlideCore.ts:711

decryptMessageContent

decryptMessageContent(recipient: WalletAccount<any>, msg: IMessage<any>, content: IMessageContent, secureContext?: MessageSecureContext, handlers?: YlidePrivateKeyHandlers): Promise<{
    container: IUnpackedMessageContainer;
    content: MessageContentV3 | MessageContentV4 | MessageContentV5;
    serviceCode: ServiceCode;
}>
Parameters
- recipient: WalletAccount<any>
- msg: IMessage<any>
- content: IMessageContent
- Optional secureContext: MessageSecureContext
- Optional handlers: YlidePrivateKeyHandlers
Returns Promise<{
    container: IUnpackedMessageContainer;
    content: MessageContentV3 | MessageContentV4 | MessageContentV5;
    serviceCode: ServiceCode;
}>
- Defined in src/core/YlideCore.ts:685

getAddressKeys

getAddressKeys(address: string): Promise<{
freshestKey: null | RemotePublicKey;
remoteKeys: Record<string, null | RemotePublicKey>;
}>
Parameters
- address: string
Returns Promise<{
freshestKey: null | RemotePublicKey;
remoteKeys: Record<string, null | RemotePublicKey>;
}>
- Defined in src/core/YlideCore.ts:230

getAddressesKeys

getAddressesKeys(addresses: string[]): Promise<Record<string, {
freshestKey: null | RemotePublicKey;
remoteKeys: Record<string, null | RemotePublicKey>;
}>>
Parameters
- addresses: string[]
Returns Promise<Record<string, {
freshestKey: null | RemotePublicKey;
remoteKeys: Record<string, null | RemotePublicKey>;
}>>
- Defined in src/core/YlideCore.ts:90

getAddressesKeysHistory

getAddressesKeysHistory(addresses: string[]): Promise<Record<string, RemotePublicKey[]>>
Parameters
- addresses: string[]
Returns Promise<Record<string, RemotePublicKey[]>>
- Defined in src/core/YlideCore.ts:331

getBlockchainGroupByBlockchain

getBlockchainGroupByBlockchain(blockchain: string): undefined | string
Parameters
- blockchain: string
Returns undefined | string
- Defined in src/core/YlideCore.ts:226

getListSources

getListSources(readingSession: SourceReadingSession, subjects: ISourceSubject[]): IListSource[]
Parameters
- readingSession: SourceReadingSession
- subjects: ISourceSubject[]
Returns IListSource[]
- Defined in src/core/YlideCore.ts:411

getMessageBlockchainController

getMessageBlockchainController(msg: IMessage<any>): null | AbstractBlockchainController
Parameters
- msg: IMessage<any>
Returns null | AbstractBlockchainController
- Defined in src/core/YlideCore.ts:578

getMessageByMsgId

getMessageByMsgId(msgId: string): Promise<null | IMessage<any>>
Parameters
- msgId: string
Returns Promise<null | IMessage<any>>
- Defined in src/core/YlideCore.ts:545

getMessageContent

getMessageContent(msg: IMessage<any>): Promise<null | IMessageCorruptedContent | IMessageContent>
Parameters
- msg: IMessage<any>
Returns Promise<null | IMessageCorruptedContent | IMessageContent>
- Defined in src/core/YlideCore.ts:559

getMessageSecureContext

getMessageSecureContext(recipient: WalletAccount<any>, msg: IMessage<any>, unpackedContainer: IUnpackedMessageContainer, handlers?: YlidePrivateKeyHandlers): Promise<MessageSecureContext>
Parameters
- recipient: WalletAccount<any>
- msg: IMessage<any>
- unpackedContainer: IUnpackedMessageContainer
- Optional handlers: YlidePrivateKeyHandlers
Returns Promise<MessageSecureContext>
- Defined in src/core/YlideCore.ts:608

getMessageWalletController

getMessageWalletController(msg: IMessage<any>, keyAddress?: Uint256): Promise<null | AbstractWalletController>
Parameters
- msg: IMessage<any>
- Optional keyAddress: Uint256
Returns Promise<null | AbstractWalletController>
- Defined in src/core/YlideCore.ts:587

sendMessage

sendMessage(__namedParameters: SendMessageArgs, walletOptions?: any): Promise<SendMailResult>
Parameters
- __namedParameters: SendMessageArgs
- Optional walletOptions: any
Returns Promise<SendMailResult>
- Defined in src/core/YlideCore.ts:481

sendSimpleMessage

sendSimpleMessage(wallet: AbstractWalletController, to: string, content: string): Promise<SendMailResult>
Parameters
- wallet: AbstractWalletController
- to: string
- content: string
Returns Promise<SendMailResult>
- Defined in src/core/YlideCore.ts:464

waitForPublicKey

waitForPublicKey(blockchain: string, address: string, key: Uint8Array, timeout?: number): Promise<null | RemotePublicKey>
Parameters
- blockchain: string
- address: string
- key: Uint8Array
- timeout: number = 60000
Returns Promise<null | RemotePublicKey>
- Defined in src/core/YlideCore.ts:77

`Static` getSentAddress

getSentAddress(recipient: Uint256): Uint256
Parameters
- recipient: Uint256
Returns Uint256
- Defined in src/core/YlideCore.ts:73

Class YlideCore

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

ylide: Ylide

controllers: YlideControllers

keysRegistry: YlideKeysRegistry

indexerBlockchains: string[] = []

Optional useWebSocketPulling: boolean

Returns YlideCore

Properties

Readonly controllers

Readonly indexer

Private Readonly indexerBlockchains

Readonly keysRegistry

Readonly ylide

Methods

broadcastMessage

Parameters

__namedParameters: BroadcastMessageArgs

Optional walletOptions: any

Returns Promise<SendBroadcastResult>

decryptBroadcastContent

Parameters

msg: IMessage<any>

content: IMessageContent

Returns { container: IUnpackedMessageContainer; content: MessageContentV3 | MessageContentV4 | MessageContentV5; serviceCode: ServiceCode; }

container: IUnpackedMessageContainer

content: MessageContentV3 | MessageContentV4 | MessageContentV5

serviceCode: ServiceCode

decryptMessageContent

Parameters

recipient: WalletAccount<any>

msg: IMessage<any>

content: IMessageContent

Optional secureContext: MessageSecureContext

Optional handlers: YlidePrivateKeyHandlers

Returns Promise<{ container: IUnpackedMessageContainer; content: MessageContentV3 | MessageContentV4 | MessageContentV5; serviceCode: ServiceCode; }>

getAddressKeys

Parameters

address: string

Returns Promise<{ freshestKey: null | RemotePublicKey; remoteKeys: Record<string, null | RemotePublicKey>; }>

getAddressesKeys

Parameters

addresses: string[]

Returns Promise<Record<string, { freshestKey: null | RemotePublicKey; remoteKeys: Record<string, null | RemotePublicKey>; }>>

getAddressesKeysHistory

Parameters

addresses: string[]

Returns Promise<Record<string, RemotePublicKey[]>>

getBlockchainGroupByBlockchain

Parameters

blockchain: string

Returns undefined | string

getListSources

Parameters

readingSession: SourceReadingSession

subjects: ISourceSubject[]

Returns IListSource[]

getMessageBlockchainController

Parameters

msg: IMessage<any>

Returns null | AbstractBlockchainController

getMessageByMsgId

Parameters

msgId: string

Returns Promise<null | IMessage<any>>

getMessageContent

Parameters

msg: IMessage<any>

Returns Promise<null | IMessageCorruptedContent | IMessageContent>

getMessageSecureContext

Parameters

recipient: WalletAccount<any>

msg: IMessage<any>

`Optional` useWebSocketPulling: boolean

`Readonly` controllers

`Readonly` indexer

`Private` `Readonly` indexerBlockchains

`Readonly` keysRegistry

`Readonly` ylide

`Optional` walletOptions: any

Returns {
container: IUnpackedMessageContainer;
content: MessageContentV3 | MessageContentV4 | MessageContentV5;
serviceCode: ServiceCode;
}

`Optional` secureContext: MessageSecureContext

`Optional` handlers: YlidePrivateKeyHandlers

Returns Promise<{
container: IUnpackedMessageContainer;
content: MessageContentV3 | MessageContentV4 | MessageContentV5;
serviceCode: ServiceCode;
}>

Returns Promise<{
freshestKey: null | RemotePublicKey;
remoteKeys: Record<string, null | RemotePublicKey>;
}>

Returns Promise<Record<string, {
freshestKey: null | RemotePublicKey;
remoteKeys: Record<string, null | RemotePublicKey>;
}>>

`Optional` handlers: YlidePrivateKeyHandlers

`Optional` keyAddress: Uint256

`Optional` walletOptions: any

`Static` getSentAddress