Class AbstractBlockchainController`Abstract`

Description

It's an abstract class designated to define an interface to read messaging data from blockchain: messages metadata, content and public keys of recipients

Example

Example of how to define your own ancestor:

import { Ylide, AbstractBlockchainController } from '@ylide/sdk';

class EverscaleBlockchainController extends AbstractBlockchainController {
    readonly registryContract: RegistryContract;

    constructor(options: { dev?: boolean } = {}) {
        super(options);

        // ...
    }

    async extractAddressFromPublicKey(
        publicKey: PublicKey
    ): Promise<string | null> {
        return this.registryContract.getAddressByPublicKey(publicKey.bytes);
    }

    // Other implementations ...
}

Hierarchy

AbstractBlockchainController

Constructors

constructor

new AbstractBlockchainController(): AbstractBlockchainController
Returns AbstractBlockchainController

Methods

`Abstract` addressToUint256

addressToUint256(address: string): Uint256
Method to convert address to 32 bytes lowercase hex string without prefix (widely used in SDK)
Parameters
- address: string
Returns Uint256
- Defined in src/abstracts/AbstractBlockchainController.ts:78

`Abstract` blockchain

blockchain(): string
Method to get blockchain name

Returns string
- Defined in src/abstracts/AbstractBlockchainController.ts:45

`Abstract` blockchainGroup

blockchainGroup(): string
Method to get blockchain group name

Description
Blockchain group is a name of the group of blockchains which are compatible with each other

Returns string
- Defined in src/abstracts/AbstractBlockchainController.ts:52

`Abstract` compareMessagesTime

compareMessagesTime(a: IMessage<any>, b: IMessage<any>): number
Method to compare messages by time. Sometimes two messages could have the same time, so we need to sort them using some internal properties (e.g. blockNumber/logicalTime/etc).

Returns
-1 if a < b, 0 if a == b, 1 if a > b

Description
This method is used to sort messages in the list
Parameters
- a: IMessage<any>
  
  First message to compare
- b: IMessage<any>
  
  Second message to compare
Returns number
- Defined in src/abstracts/AbstractBlockchainController.ts:194

`Abstract` defaultNameService

defaultNameService(): null | AbstractNameService
Method to get instance of the default name service for this blockchain (if not available - returns null)

Returns null | AbstractNameService
- Defined in src/abstracts/AbstractBlockchainController.ts:63

`Abstract` executeExtraEncryptionStrategy

executeExtraEncryptionStrategy(entries: IExtraEncryptionStrateryEntry[], bulk: IExtraEncryptionStrateryBulk, addedPublicKeyIndex: null | number, messageKey: Uint8Array): Promise<MessageKey[]>
Method to get execute non-Ylide encryption strategies for address - actually encrypt the message key. It is intended to be used via DynamicEncryptionRouter (or even just YlideCore), not for manual usage
Parameters
- entries: IExtraEncryptionStrateryEntry[]
- bulk: IExtraEncryptionStrateryBulk
- addedPublicKeyIndex: null | number
- messageKey: Uint8Array
Returns Promise<MessageKey[]>
- Defined in src/abstracts/AbstractBlockchainController.ts:178

`Abstract` extractPublicKeyFromAddress

extractPublicKeyFromAddress(address: string): Promise<null | RemotePublicKey>
Method to get public key of the recipient by address. If key is not registered - you will get null.
Parameters
- address: string
  
  Recipient's wallet address
Returns Promise<null | RemotePublicKey>
- Defined in src/abstracts/AbstractBlockchainController.ts:129

`Abstract` extractPublicKeysHistoryByAddress

extractPublicKeysHistoryByAddress(address: string): Promise<RemotePublicKey[]>
Method to get public keys history of the certain address.
Parameters
- address: string
  
  Recipient's wallet address
Returns Promise<RemotePublicKey[]>
- Defined in src/abstracts/AbstractBlockchainController.ts:136

`Abstract` getBalance

getBalance(address: string): Promise<{
    e18: string;
    numeric: number;
    original: string;
}>
Method to get balance of the address. Currency used is the same which is used to pay for the Ylide tx in this blockchain. Usually it is the smallest native currency (e.g. wei in Ethereum)

Returns
Decimal number in a string format
Parameters
- address: string
  
  Recipient's wallet address
Returns Promise<{
    e18: string;
    numeric: number;
    original: string;
}>
- Defined in src/abstracts/AbstractBlockchainController.ts:145

`Abstract` getBlockchainSourceSubjects

getBlockchainSourceSubjects(subject: ISourceSubject): IBlockchainSourceSubject[]
Method to get wide list of subjects for which you will get messages from this blockchain It is intended to be used via ListMultiplexer, not for manual usage
Parameters
- subject: ISourceSubject
  
  Description of a filtering criteria for the messages
Returns IBlockchainSourceSubject[]
- Defined in src/abstracts/AbstractBlockchainController.ts:108

`Abstract` getExtraEncryptionStrategiesFromAddress

getExtraEncryptionStrategiesFromAddress(address: string): Promise<IExtraEncryptionStrateryEntry[]>
Method to get instantiate non-Ylide encryption strategies for the address.
Parameters
- address: string
  
  Recipient's wallet address
Returns Promise<IExtraEncryptionStrateryEntry[]>
- Defined in src/abstracts/AbstractBlockchainController.ts:152

`Abstract` getMessageByMsgId

getMessageByMsgId(msgId: string): Promise<null | IMessage<any>>
Method to get message by msgId
Parameters
- msgId: string
  
  Msg ID to check
Returns Promise<null | IMessage<any>>
- Defined in src/abstracts/AbstractBlockchainController.ts:93

`Abstract` getRecipientReadingRules

getRecipientReadingRules(recipient: Uint256): Promise<any>
Method to retrieve recipient rules for getting messages
Parameters
- recipient: Uint256
  
  Address of the wallet you want to retrieve rules of
Returns Promise<any>
- Defined in src/abstracts/AbstractBlockchainController.ts:100

`Abstract` getSupportedExtraEncryptionStrategies

getSupportedExtraEncryptionStrategies(): string[]
Method to get available non-Ylide encryption strategies for the address.

Returns string[]
- Defined in src/abstracts/AbstractBlockchainController.ts:159

`Abstract` ininiateMessagesSource

ininiateMessagesSource(subject: IBlockchainSourceSubject): LowLevelMessagesSource
Method to instantiate messages source for a certain filtering criteria
Parameters
- subject: IBlockchainSourceSubject
  
  Description of a filtering criteria for the messages
Returns LowLevelMessagesSource
- Defined in src/abstracts/AbstractBlockchainController.ts:115

`Abstract` init

init(): Promise<void>
Method to init controller. Must be called once before any other method. Automatically called when you instantiate using Ylide signleton.

Returns Promise<void>
- Defined in src/abstracts/AbstractBlockchainController.ts:58

`Abstract` isAddressValid

isAddressValid(address: string): boolean
Method to check address validity in this blockchain
Parameters
- address: string
Returns boolean
- Defined in src/abstracts/AbstractBlockchainController.ts:73

`Abstract` isReadingBySenderAvailable

isReadingBySenderAvailable(): boolean
Method to get whether reading by individual sender is possible or not

Returns boolean
- Defined in src/abstracts/AbstractBlockchainController.ts:68

`Abstract` isValidMsgId

isValidMsgId(msgId: string): boolean
Method to check if this msgId is valid for this blockchain controller

Returns
true if msgId is valid for this blockchain
Parameters
- msgId: string
  
  Msg ID to check
Returns boolean
- Defined in src/abstracts/AbstractBlockchainController.ts:86

`Abstract` prepareExtraEncryptionStrategyBulk

prepareExtraEncryptionStrategyBulk(entries: IExtraEncryptionStrateryEntry[]): Promise<IExtraEncryptionStrateryBulk>
Method to combine non-Ylide encryption strategies to be sent to the recipient. It is intended to be used via DynamicEncryptionRouter (or even just YlideCore), not for manual usage

Returns
Bulk to be sent to the recipient
Parameters
- entries: IExtraEncryptionStrateryEntry[]
  
  Entries to process
Returns Promise<IExtraEncryptionStrateryBulk>
- Defined in src/abstracts/AbstractBlockchainController.ts:168

`Abstract` retrieveMessageContent

retrieveMessageContent(msg: IMessage<any>): Promise<null | IMessageCorruptedContent | IMessageContent>
Method to retrieve the content of a certain message from blockchain
Parameters
- msg: IMessage<any>
  
  Message to retrieve content of
Returns Promise<null | IMessageCorruptedContent | IMessageContent>
- Defined in src/abstracts/AbstractBlockchainController.ts:122

Class AbstractBlockchainControllerAbstract

Description

Example

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns AbstractBlockchainController

Methods

Abstract addressToUint256

Parameters

address: string

Returns Uint256

Abstract blockchain

Returns string

Abstract blockchainGroup

Description

Returns string

Abstract compareMessagesTime

Returns

Description

Parameters

a: IMessage<any>

b: IMessage<any>

Returns number

Abstract defaultNameService

Returns null | AbstractNameService

Abstract executeExtraEncryptionStrategy

Parameters

entries: IExtraEncryptionStrateryEntry[]

bulk: IExtraEncryptionStrateryBulk

addedPublicKeyIndex: null | number

messageKey: Uint8Array

Returns Promise<MessageKey[]>

Abstract extractPublicKeyFromAddress

Parameters

address: string

Returns Promise<null | RemotePublicKey>

Abstract extractPublicKeysHistoryByAddress

Parameters

address: string

Returns Promise<RemotePublicKey[]>

Abstract getBalance

Returns

Parameters

address: string

Returns Promise<{ e18: string; numeric: number; original: string; }>

Abstract getBlockchainSourceSubjects

Parameters

subject: ISourceSubject

Returns IBlockchainSourceSubject[]

Abstract getExtraEncryptionStrategiesFromAddress

Parameters

address: string

Returns Promise<IExtraEncryptionStrateryEntry[]>

Abstract getMessageByMsgId

Parameters

msgId: string

Returns Promise<null | IMessage<any>>

Abstract getRecipientReadingRules

Parameters

recipient: Uint256

Returns Promise<any>

Abstract getSupportedExtraEncryptionStrategies

Returns string[]

Abstract ininiateMessagesSource

Parameters

subject: IBlockchainSourceSubject

Returns LowLevelMessagesSource

Abstract init

Returns Promise<void>

Abstract isAddressValid

Parameters

address: string

Returns boolean

Abstract isReadingBySenderAvailable

Returns boolean

Abstract isValidMsgId

Class AbstractBlockchainController`Abstract`

`Abstract` addressToUint256

`Abstract` blockchain

`Abstract` blockchainGroup

`Abstract` compareMessagesTime

`Abstract` defaultNameService

`Abstract` executeExtraEncryptionStrategy

`Abstract` extractPublicKeyFromAddress

`Abstract` extractPublicKeysHistoryByAddress

`Abstract` getBalance

Returns Promise<{
e18: string;
numeric: number;
original: string;
}>

`Abstract` getBlockchainSourceSubjects

`Abstract` getExtraEncryptionStrategiesFromAddress

`Abstract` getMessageByMsgId

`Abstract` getRecipientReadingRules

`Abstract` getSupportedExtraEncryptionStrategies

`Abstract` ininiateMessagesSource

`Abstract` init

`Abstract` isAddressValid

`Abstract` isReadingBySenderAvailable

`Abstract` isValidMsgId

`Abstract` prepareExtraEncryptionStrategyBulk

`Abstract` retrieveMessageContent