CircuitString

o1js / Modules / CircuitString

Class: CircuitString

Deprecated

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

Hierarchy

• CircuitValue

  ↳ CircuitString

Table of contents

Constructors

• constructor

Properties

• values
• maxLength

Methods

• append
• assertEquals
• computeLengthAndMask
• equals
• hash
• isConstant
• length
• lengthMask
• maxLength
• substring
• toConstant
• toFields
• toJSON
• toString
• check
• empty
• fromCharacters
• fromFields
• fromJSON
• fromObject
• fromString
• sizeInFields
• toAuxiliary
• toConstant
• toFields
• toInput
• toJSON

Constructors

constructor

• Private new CircuitString(values)

Parameters

Name	Type
values	Character[]

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

Name	Type
str	CircuitString

Returns

CircuitString

Defined in

lib/string.ts:89

---

assertEquals

▸ assertEquals(x): void

Parameters

Name	Type
x	CircuitString

Returns

void

Inherited from

CircuitValue.assertEquals

Defined in

lib/circuit_value.ts:166

---

computeLengthAndMask

▸ Private computeLengthAndMask(): Object

Returns

Object

Name	Type
length	Field
mask	Bool[]

Defined in

lib/string.ts:59

---

equals

▸ equals(x): Bool

Parameters

Name	Type
x	CircuitString

Returns

Bool

Inherited from

CircuitValue.equals

Defined in

lib/circuit_value.ts:162

---

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:170

---

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

Name	Type
start	number
end	number

Returns

CircuitString

Defined in

lib/string.ts:129

---

toConstant

▸ toConstant(): CircuitString

Returns

CircuitString

Inherited from

CircuitValue.toConstant

Defined in

lib/circuit_value.ts:158

---

toFields

▸ toFields(): Field[]

Returns

Field[]

Inherited from

CircuitValue.toFields

Defined in

lib/circuit_value.ts:150

---

toJSON

▸ toJSON(): any

Returns

any

Inherited from

CircuitValue.toJSON

Defined in

lib/circuit_value.ts:154

---

toString

▸ toString(): string

Returns

string

Defined in

lib/string.ts:133

---

check

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

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
v	InstanceType\<T>

Returns

void

Inherited from

CircuitValue.check

Defined in

lib/circuit_value.ts:199

---

empty

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

Type parameters

Name	Type
T	extends AnyConstructor

Returns

InstanceType\<T>

Inherited from

CircuitValue.empty

Defined in

lib/circuit_value.ts:254

---

fromCharacters

▸ Static fromCharacters(chars): CircuitString

Parameters

Name	Type
chars	Character[]

Returns

CircuitString

Defined in

lib/string.ts:50

---

fromFields

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

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
xs	Field[]

Returns

InstanceType\<T>

Inherited from

CircuitValue.fromFields

Defined in

lib/circuit_value.ts:174

---

fromJSON

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

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
value	any

Returns

InstanceType\<T>

Inherited from

CircuitValue.fromJSON

Defined in

lib/circuit_value.ts:232

---

fromObject

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

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
value	NonMethods\<InstanceType\<T>>

Returns

InstanceType\<T>

Inherited from

CircuitValue.fromObject

Defined in

lib/circuit_value.ts:95

---

fromString

▸ Static fromString(str): CircuitString

Parameters

Name	Type
str	string

Returns

CircuitString

Defined in

lib/string.ts:140

---

sizeInFields

▸ Static sizeInFields(): number

Returns

number

Inherited from

CircuitValue.sizeInFields

Defined in

lib/circuit_value.ts:102

---

toAuxiliary

▸ Static toAuxiliary(): []

Returns

[]

Inherited from

CircuitValue.toAuxiliary

Defined in

lib/circuit_value.ts:124

---

toConstant

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

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
t	InstanceType\<T>

Returns

InstanceType\<T>

Inherited from

CircuitValue.toConstant

Defined in

lib/circuit_value.ts:213

---

toFields

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

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
v	InstanceType\<T>

Returns

Field[]

Inherited from

CircuitValue.toFields

Defined in

lib/circuit_value.ts:107

---

toInput

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

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
v	InstanceType\<T>

Returns

HashInput

Inherited from

CircuitValue.toInput

Defined in

lib/circuit_value.ts:128

---

toJSON

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

Type parameters

Name	Type
T	extends AnyConstructor

Parameters

Name	Type
this	T
v	InstanceType\<T>

Returns

any

Inherited from

CircuitValue.toJSON

Defined in

lib/circuit_value.ts:221