Class WitnessArgs

Hierarchy

Impl<WitnessArgsLike, WitnessArgs, any, this>
- WitnessArgs

Index

Constructors

constructor

new WitnessArgs(
    lock?: `0x${string}`,
    inputType?: `0x${string}`,
    outputType?: `0x${string}`,
): WitnessArgs
Creates an instance of WitnessArgs.
Parameters
- Optionallock: `0x${string}`
  The optional lock field of the witness.
- OptionalinputType: `0x${string}`
  The optional input type field of the witness.
- OptionaloutputType: `0x${string}`
  The optional output type field of the witness.
Returns WitnessArgs
Overrides Entity.Base<WitnessArgsLike, WitnessArgs>().constructor
- Defined in ckb/transaction.ts:1075

Properties

`Optional`lock

lock?: `0x${string}`

The optional lock field of the witness.

`Optional`inputType

inputType?: `0x${string}`

The optional input type field of the witness.

`Optional`outputType

outputType?: `0x${string}`

The optional output type field of the witness.

`Static` `Optional`byteLength

byteLength?: number

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

Static

Methods

`Static`from

from(witnessArgs: WitnessArgsLike): WitnessArgs
Creates a WitnessArgs instance from a WitnessArgsLike object.
Parameters
- witnessArgs: WitnessArgsLike
  A WitnessArgsLike object or an instance of WitnessArgs.
Returns WitnessArgs
A WitnessArgs instance.
Example
```
const witnessArgs = WitnessArgs.from({
  lock: "0x...",
  inputType: "0x...",
  outputType: "0x..."
});
```
Overrides Entity.Base<WitnessArgsLike, WitnessArgs>().from
- Defined in ckb/transaction.ts:1099

`Static`Base

Base<SubTypeLike, SubType = SubTypeLike, Context = any>(): typeof Impl
Generate a base class of CCC to create a serializable instance. This should be used with the codec decorator.
Type Parameters
- SubTypeLike
- SubType = SubTypeLike
- Context = any
Returns typeof Impl
Inherited from Entity.Base
- Defined in codec/entity.ts:18

`Static`encode

encode(_: WitnessArgsLike): Bytes
Encode the entity into bytes
Parameters
- _: WitnessArgsLike
  The entity to encode
Returns Bytes
The encoded bytes

Static

Throws
Will throw an error if the entity is not serializable
Inherited from Entity.Base<WitnessArgsLike, WitnessArgs>().encode
- Defined in codec/entity.ts:39

`Static`decode

decode(_: BytesLike, _context?: any): WitnessArgs
Decode the entity from bytes
Parameters
- _: BytesLike
  The bytes to decode
- Optional_context: any
  Optional context passed to the codec
Returns WitnessArgs
The decoded entity

Static

Throws
Will throw an error if the entity is not serializable
Inherited from Entity.Base<WitnessArgsLike, WitnessArgs>().decode
- Defined in codec/entity.ts:53

`Static`fromBytes

fromBytes(_bytes: BytesLike, _context?: any): WitnessArgs
Create an entity from bytes
Parameters
- _bytes: BytesLike
- Optional_context: any
  Optional context passed to the codec
Returns WitnessArgs
The created entity

Static

Throws
Will throw an error if the entity is not serializable
Inherited from Entity.Base<WitnessArgsLike, WitnessArgs>().fromBytes
- Defined in codec/entity.ts:68

toBytes

toBytes(): Bytes
Convert the entity to bytes

Returns Bytes
The bytes representation of the entity
Inherited from Entity.Base<WitnessArgsLike, WitnessArgs>().toBytes
- Defined in codec/entity.ts:91

clone

clone(): WitnessArgs
Create a clone of the entity

Returns WitnessArgs
A clone of the entity
Inherited from Entity.Base<WitnessArgsLike, WitnessArgs>().clone
- Defined in codec/entity.ts:103

eq

eq(other: WitnessArgsLike): boolean
Check if the entity is equal to another entity
Parameters
- other: WitnessArgsLike
  The other entity to compare with
Returns boolean
True if the entities are equal, false otherwise
Inherited from Entity.Base<WitnessArgsLike, WitnessArgs>().eq
- Defined in codec/entity.ts:113

hash

hash(): `0x${string}`
Calculate the hash of the entity

Returns `0x${string}`
The hash of the entity
Inherited from Entity.Base<WitnessArgsLike, WitnessArgs>().hash
- Defined in codec/entity.ts:133

toHex

toHex(): `0x${string}`
Convert the entity to a full-byte untrimmed Hex representation

Returns `0x${string}`
The entity full-byte untrimmed hexadecimal representation
Inherited from Entity.Base<WitnessArgsLike, WitnessArgs>().toHex
- Defined in codec/entity.ts:142

`Static`BaseUnion

BaseUnion<
    CodecType extends CodecLike<any, { type: any; value: unknown }, any>,
    SubTypeLike,
    SubType = SubTypeLike,
>(): typeof Impl
Generate a base class of CCC to create a serializable Union instance. This should be used with the codec decorator.
Type Parameters
- CodecType extends CodecLike<any, { type: any; value: unknown }, any>
- SubTypeLike
- SubType = SubTypeLike
Returns typeof Impl
Inherited from Entity.BaseUnion
- Defined in codec/entity.ts:189

Class WitnessArgs

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns WitnessArgs

Properties

Optionallock

OptionalinputType

OptionaloutputType

Static OptionalbyteLength

Static

Methods

Staticfrom

Parameters

Returns WitnessArgs

Example

StaticBase

Type Parameters

Returns typeof Impl

Staticencode

Parameters

Returns Bytes

Static

Throws

Staticdecode

Parameters

Returns WitnessArgs

Static

Throws

StaticfromBytes

Parameters

Returns WitnessArgs

Static

Throws

toBytes

Returns Bytes

clone

Returns WitnessArgs

eq

Parameters

Returns boolean

hash

Returns `0x${string}`

toHex

Returns `0x${string}`

StaticBaseUnion

Type Parameters

Returns typeof Impl

Settings

On This Page

`Optional`lock

`Optional`inputType

`Optional`outputType

`Static` `Optional`byteLength

`Static`from

`Static`Base

`Static`encode

`Static`decode

`Static`fromBytes

`Static`BaseUnion