Class Bytes

Interface that should be implemented by ABI serializable objects.

Hierarchy

Bytes

Implements

ABISerializableObject

Index

Constructors

Properties

Accessors

hexString length utf8String

Methods

append appending copy dropFirst droppingFirst equals toABI toJSON toString zeropad zeropadded abiDefault equal from fromABI fromString isBytes random

Constructors

constructor

new Bytes(array?: Uint8Array): Bytes
Parameters
- array: Uint8Array = ...
Returns Bytes
- Defined in src/chain/bytes.ts:81

Properties

array

array: Uint8Array

`Static` abiName

abiName: string = 'bytes'

Accessors

hexString

get hexString(): string
Hex string representation of this instance.

Returns string
- Defined in src/chain/bytes.ts:91

length

get length(): number
Number of bytes in this instance.

Returns number
- Defined in src/chain/bytes.ts:86

utf8String

get utf8String(): string
UTF-8 string representation of this instance.

Returns string
- Defined in src/chain/bytes.ts:96

Methods

append

append(other: AnyBytes): void
Mutating. Append bytes to this instance.
Parameters
- other: AnyBytes
Returns void
- Defined in src/chain/bytes.ts:101

appending

appending(other: AnyBytes): Bytes
Non-mutating, returns a copy of this instance with appended bytes.
Parameters
- other: AnyBytes
Returns Bytes
- Defined in src/chain/bytes.ts:112

copy

copy(): Bytes
Returns Bytes
- Defined in src/chain/bytes.ts:149

dropFirst

dropFirst(n?: number): void
Mutating. Drop bytes from the start of this instance.
Parameters
- n: number = 1
Returns void
- Defined in src/chain/bytes.ts:140

droppingFirst

droppingFirst(n?: number): Bytes
Non-mutating, returns a copy of this instance with dropped bytes from the start.
Parameters
- n: number = 1
Returns Bytes
- Defined in src/chain/bytes.ts:145

equals

equals(other: AnyBytes): boolean
Return true if the object equals the other object passed.
Parameters
- other: AnyBytes
Returns boolean
Implementation of ABISerializableObject.equals
- Defined in src/chain/bytes.ts:156

toABI

toABI(encoder: ABIEncoder): void
Called when encoding to binary abi format.
Parameters
- encoder: ABIEncoder
Returns void
Implementation of ABISerializableObject.toABI
- Defined in src/chain/bytes.ts:170

toJSON

toJSON(): string
Called when encoding to json abi format.

Returns string
Implementation of ABISerializableObject.toJSON
- Defined in src/chain/bytes.ts:175

toString

toString(encoding?: BytesEncoding): string
Parameters
- encoding: BytesEncoding = 'hex'
Returns string
- Defined in src/chain/bytes.ts:160

zeropad

zeropad(n: number, truncate?: boolean): void
Mutating. Pad this instance to length.
Parameters
- n: number
- truncate: boolean = false
Returns void
- Defined in src/chain/bytes.ts:119

zeropadded

zeropadded(n: number, truncate?: boolean): Bytes
Non-mutating, returns a copy of this instance with zeros padded.
Parameters
- n: number
- truncate: boolean = false
Returns Bytes
- Defined in src/chain/bytes.ts:133

`Static` abiDefault

abiDefault(): Bytes
Returns Bytes
- Defined in src/chain/bytes.ts:53

`Static` equal

equal(a: BytesType, b: BytesType): boolean
Parameters
- a: BytesType
- b: BytesType
Returns boolean
- Defined in src/chain/bytes.ts:57

`Static` from

from(value: AnyBytes, encoding?: BytesEncoding): Bytes
Create a new Bytes instance.

Note
Make sure to take a copy before mutating the bytes as the underlying source is not copied here.
Parameters
- value: AnyBytes
- Optional encoding: BytesEncoding
Returns Bytes
- Defined in src/chain/bytes.ts:20

`Static` fromABI

fromABI(decoder: ABIDecoder): Bytes
Parameters
- decoder: ABIDecoder
Returns Bytes
- Defined in src/chain/bytes.ts:48

`Static` fromString

fromString(value: string, encoding?: BytesEncoding): Bytes
Parameters
- value: string
- encoding: BytesEncoding = 'hex'
Returns Bytes
- Defined in src/chain/bytes.ts:36

`Static` isBytes

isBytes(value: any): value is BytesType
Return true if given value is a valid BytesType.
Parameters
- value: any
Returns value is BytesType
- Defined in src/chain/bytes.ts:66

`Static` random

random(length: number): Bytes
Parameters
- length: number
Returns Bytes
- Defined in src/chain/bytes.ts:61

Generated using TypeDoc