Represents a Chain.

Hierarchy

  • Chain

Implements

Constructors

Properties

chainKey?: null | IChainKey

Chain chainKey.

Chain messageKeys.

senderRatchetKey: Uint8Array

Chain senderRatchetKey.

senderRatchetKeyPrivate: Uint8Array

Chain senderRatchetKeyPrivate.

Methods

  • Converts this Chain to JSON.

    Returns {
        [k: string]: any;
    }

    JSON object

    • [k: string]: any
  • Creates a new Chain instance using the specified properties.

    Parameters

    • Optional properties: IChain

      Properties to set

    Returns Chain

    Chain instance

  • Decodes a Chain message from the specified reader or buffer.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    • Optional length: number

      Message length if known beforehand

    Returns Chain

    Chain

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

  • Decodes a Chain message from the specified reader or buffer, length delimited.

    Parameters

    • reader: Uint8Array | Reader

      Reader or buffer to decode from

    Returns Chain

    Chain

    Throws

    If the payload is not a reader or valid buffer

    Throws

    If required fields are missing

  • Encodes the specified Chain message. Does not implicitly verify messages.

    Parameters

    • message: IChain

      Chain message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

  • Encodes the specified Chain message, length delimited. Does not implicitly verify messages.

    Parameters

    • message: IChain

      Chain message or plain object to encode

    • Optional writer: Writer

      Writer to encode to

    Returns Writer

    Writer

  • Creates a Chain message from a plain object. Also converts values to their respective internal types.

    Parameters

    • object: {
          [k: string]: any;
      }

      Plain object

      • [k: string]: any

    Returns Chain

    Chain

  • Creates a plain object from a Chain message. Also converts values to other types if specified.

    Parameters

    • message: Chain

      Chain

    • Optional options: IConversionOptions

      Conversion options

    Returns {
        [k: string]: any;
    }

    Plain object

    • [k: string]: any
  • Verifies a Chain message.

    Parameters

    • message: {
          [k: string]: any;
      }

      Plain object to verify

      • [k: string]: any

    Returns null | string

    null if valid, otherwise the reason why it is not

Generated using TypeDoc