Skip to main content

CircuitString

o1js / Modules / CircuitString

Class: CircuitString

Deprecated

CircuitValue is deprecated in favor of Struct, which features a simpler API and better typing.

Hierarchy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

Private new CircuitString(values)

Parameters

NameType
valuesCharacter[]

Overrides

CircuitValue.constructor

Defined in

lib/string.ts:46

Properties

values

values: Character[]

Defined in

lib/string.ts:41


maxLength

Static maxLength: number = DEFAULT_STRING_LENGTH

Defined in

lib/string.ts:40

Methods

append

append(str): CircuitString

appends another string to this one, returns the result and proves that it fits within the maxLength of this string (the other string can have a different maxLength)

Parameters

NameType
strCircuitString

Returns

CircuitString

Defined in

lib/string.ts:89


assertEquals

assertEquals(x): void

Parameters

NameType
xCircuitString

Returns

void

Inherited from

CircuitValue.assertEquals

Defined in

lib/circuit-value.ts:167


computeLengthAndMask

Private computeLengthAndMask(): Object

Returns

Object

NameType
lengthField
maskBool[]

Defined in

lib/string.ts:59


equals

equals(x): Bool

Parameters

NameType
xCircuitString

Returns

Bool

Inherited from

CircuitValue.equals

Defined in

lib/circuit-value.ts:163


hash

hash(): Field

returns true if str is found in this CircuitString

Returns

Field

Defined in

lib/string.ts:125


isConstant

isConstant(): boolean

Returns

boolean

Inherited from

CircuitValue.isConstant

Defined in

lib/circuit-value.ts:171


length

Private length(): Field

Returns

Field

Defined in

lib/string.ts:81


lengthMask

Private lengthMask(): Bool[]

Returns

Bool[]

Defined in

lib/string.ts:78


maxLength

Private maxLength(): number

Returns

number

Defined in

lib/string.ts:54


substring

substring(start, end): CircuitString

Parameters

NameType
startnumber
endnumber

Returns

CircuitString

Defined in

lib/string.ts:129


toConstant

toConstant(): CircuitString

Returns

CircuitString

Inherited from

CircuitValue.toConstant

Defined in

lib/circuit-value.ts:159


toFields

toFields(): Field[]

Returns

Field[]

Inherited from

CircuitValue.toFields

Defined in

lib/circuit-value.ts:151


toJSON

toJSON(): any

Returns

any

Inherited from

CircuitValue.toJSON

Defined in

lib/circuit-value.ts:155


toString

toString(): string

Returns

string

Defined in

lib/string.ts:133


check

Static check\<T>(this, v): void

Type parameters

NameType
Textends AnyConstructor

Parameters

NameType
thisT
vInstanceType\<T>

Returns

void

Inherited from

CircuitValue.check

Defined in

lib/circuit-value.ts:200


empty

Static empty\<T>(): InstanceType\<T>

Type parameters

NameType
Textends AnyConstructor

Returns

InstanceType\<T>

Inherited from

CircuitValue.empty

Defined in

lib/circuit-value.ts:255


fromCharacters

Static fromCharacters(chars): CircuitString

Parameters

NameType
charsCharacter[]

Returns

CircuitString

Defined in

lib/string.ts:50


fromFields

Static fromFields\<T>(this, xs): InstanceType\<T>

Type parameters

NameType
Textends AnyConstructor

Parameters

NameType
thisT
xsField[]

Returns

InstanceType\<T>

Inherited from

CircuitValue.fromFields

Defined in

lib/circuit-value.ts:175


fromJSON

Static fromJSON\<T>(this, value): InstanceType\<T>

Type parameters

NameType
Textends AnyConstructor

Parameters

NameType
thisT
valueany

Returns

InstanceType\<T>

Inherited from

CircuitValue.fromJSON

Defined in

lib/circuit-value.ts:233


fromObject

Static fromObject\<T>(this, value): InstanceType\<T>

Type parameters

NameType
Textends AnyConstructor

Parameters

NameType
thisT
valueNonMethods\<InstanceType\<T>>

Returns

InstanceType\<T>

Inherited from

CircuitValue.fromObject

Defined in

lib/circuit-value.ts:96


fromString

Static fromString(str): CircuitString

Parameters

NameType
strstring

Returns

CircuitString

Defined in

lib/string.ts:140


sizeInFields

Static sizeInFields(): number

Returns

number

Inherited from

CircuitValue.sizeInFields

Defined in

lib/circuit-value.ts:103


toAuxiliary

Static toAuxiliary(): []

Returns

[]

Inherited from

CircuitValue.toAuxiliary

Defined in

lib/circuit-value.ts:125


toConstant

Static toConstant\<T>(this, t): InstanceType\<T>

Type parameters

NameType
Textends AnyConstructor

Parameters

NameType
thisT
tInstanceType\<T>

Returns

InstanceType\<T>

Inherited from

CircuitValue.toConstant

Defined in

lib/circuit-value.ts:214


toFields

Static toFields\<T>(this, v): Field[]

Type parameters

NameType
Textends AnyConstructor

Parameters

NameType
thisT
vInstanceType\<T>

Returns

Field[]

Inherited from

CircuitValue.toFields

Defined in

lib/circuit-value.ts:108


toInput

Static toInput\<T>(this, v): HashInput

Type parameters

NameType
Textends AnyConstructor

Parameters

NameType
thisT
vInstanceType\<T>

Returns

HashInput

Inherited from

CircuitValue.toInput

Defined in

lib/circuit-value.ts:129


toJSON

Static toJSON\<T>(this, v): any

Type parameters

NameType
Textends AnyConstructor

Parameters

NameType
thisT
vInstanceType\<T>

Returns

any

Inherited from

CircuitValue.toJSON

Defined in

lib/circuit-value.ts:222