CCC Docs
    Preparing search index...

    Class WitnessArgs

    Hierarchy

    • Impl<
          {
              lock?: BytesLike
              | null;
              inputType?: BytesLike | null;
              outputType?: BytesLike | null;
          } & {},
          WitnessArgs,
          this,
      >
      • WitnessArgs
    Index

    Constructors

    constructor

    Properties

    lock? inputType? outputType? byteLength? encode decode fromBytes from

    Methods

    Base toBytes clone eq hash toHex BaseUnion

    Constructors

    • Creates an instance of WitnessArgs.

      Parameters

      • lock: DecodedRecord<
            {
                lock: Codec<BytesLike | null | undefined, `0x${string}` | undefined>;
                inputType: Codec<BytesLike | null | undefined, `0x${string}` | undefined>;
                outputType: Codec<BytesLike | null | undefined, `0x${string}` | undefined>;
            },
        >

        The optional lock field of the witness.

      Returns WitnessArgs

    Properties

    lock?: `0x${string}`
    inputType?: `0x${string}`
    outputType?: `0x${string}`
    byteLength?: number

    The bytes length of the entity, if it is fixed, otherwise undefined

    encode: (
        _: {
            lock?: BytesLike | null;
            inputType?: BytesLike | null;
            outputType?: BytesLike | null;
        } & {},
    ) => Bytes

    Encode the entity into bytes

    Type Declaration

      • (
            _: {
                lock?: BytesLike | null;
                inputType?: BytesLike | null;
                outputType?: BytesLike | null;
            } & {},
        ): Bytes

      • Parameters

        • _: {
              lock?: BytesLike | null;
              inputType?: BytesLike | null;
              outputType?: BytesLike | null;
          } & {}

          The entity to encode

        Returns Bytes

        The encoded bytes

    Will throw an error if the entity is not serializable

    decode: (
        _: BytesLike,
        _config?: { isExtraFieldIgnored?: boolean },
    ) => WitnessArgs

    Decode the entity from bytes

    Type Declaration

      • (_: BytesLike, _config?: { isExtraFieldIgnored?: boolean }): WitnessArgs

      • Parameters

        • _: BytesLike

          The bytes to decode

        • Optional_config: { isExtraFieldIgnored?: boolean }

          The configuration for decoding, including whether to ignore extra fields

        Returns WitnessArgs

        The decoded entity

    Will throw an error if the entity is not serializable

    fromBytes: (
        _bytes: BytesLike,
        _config?: { isExtraFieldIgnored?: boolean },
    ) => WitnessArgs

    Create an entity from bytes

    Type Declaration

      • (_bytes: BytesLike, _config?: { isExtraFieldIgnored?: boolean }): WitnessArgs

      • Parameters

        • _bytes: BytesLike
        • Optional_config: { isExtraFieldIgnored?: boolean }

          The configuration for decoding, including whether to ignore extra fields

        Returns WitnessArgs

        The created entity

    Will throw an error if the entity is not serializable

    from: (
        _: {
            lock?: BytesLike | null;
            inputType?: BytesLike | null;
            outputType?: BytesLike | null;
        } & {},
    ) => WitnessArgs

    Create an entity from a serializable object

    Type Declaration

      • (
            _: {
                lock?: BytesLike | null;
                inputType?: BytesLike | null;
                outputType?: BytesLike | null;
            } & {},
        ): WitnessArgs

      • Parameters

        • _: {
              lock?: BytesLike | null;
              inputType?: BytesLike | null;
              outputType?: BytesLike | null;
          } & {}

          The serializable object to create the entity from

        Returns WitnessArgs

        The created entity

    Will throw an error if the entity is not serializable

    Methods

    • Convert the entity to bytes

      Returns Bytes

      The bytes representation of the entity

    • Check if the entity is equal to another entity

      Parameters

      • other: {
            lock?: BytesLike | null;
            inputType?: BytesLike | null;
            outputType?: BytesLike | null;
        } & {}

        The other entity to compare with

      Returns boolean

      True if the entities are equal, false otherwise

    • Calculate the hash of the entity

      Returns `0x${string}`

      The hash of the entity

    • Convert the entity to a full-byte untrimmed Hex representation

      Returns `0x${string}`

      The entity full-byte untrimmed hexadecimal representation

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods