Class: TokenSymbol

Hierarchy

• { field: Field ; symbol: string }

  ↳ TokenSymbol

Table of contents

Constructors

• constructor

Properties

• field
• symbol
• _isStruct
• check
• fromFields
• fromJSON
• toAuxiliary
• toFields
• toInput
• toJSON

Accessors

• empty

Methods

• from
• sizeInFields

Constructors

constructor

• new TokenSymbol(value)

Parameters

Name	Type
value	Object
value.field	Field
value.symbol	string

Inherited from

Struct(TokenSymbolPure).constructor

Defined in

lib/circuit_value.ts:467

Properties

field

• field: Field

Inherited from

Struct(TokenSymbolPure).field

Defined in

lib/hash.ts:141

---

symbol

• symbol: string

Inherited from

Struct(TokenSymbolPure).symbol

Defined in

lib/hash.ts:141

---

_isStruct

▪ Static _isStruct: true

Inherited from

Struct(TokenSymbolPure)._isStruct

Defined in

lib/circuit_value.ts:467

---

check

▪ Static check: (x: { field: Field ; symbol: string }) => void

Type declaration

▸ (x): void

Parameters

Name	Type
x	Object
x.field	Field
x.symbol	string

Returns

void

Inherited from

Struct(TokenSymbolPure).check

Defined in

snarky.d.ts:37

---

fromFields

▪ Static fromFields: (x: Field[], aux: any[]) => { field: Field ; symbol: string }

Type declaration

▸ (x, aux): Object

Parameters

Name	Type
x	Field[]
aux	any[]

Returns

Object

Name	Type
field	Field
symbol	string

Inherited from

Struct(TokenSymbolPure).fromFields

Defined in

snarky.d.ts:35

---

fromJSON

▪ Static fromJSON: (x: string) => { field: Field ; symbol: string }

Type declaration

▸ (x): Object

Parameters

Name	Type
x	string

Returns

Object

Name	Type
field	Field
symbol	string

Inherited from

Struct(TokenSymbolPure).fromJSON

Defined in

lib/circuit_value.ts:475

---

toAuxiliary

▪ Static toAuxiliary: (x?: { field: Field ; symbol: string }) => any[]

Type declaration

▸ (x?): any[]

Parameters

Name	Type
x?	Object
x.field	Field
x.symbol	string

Returns

any[]

Inherited from

Struct(TokenSymbolPure).toAuxiliary

Defined in

snarky.d.ts:34

---

toFields

▪ Static toFields: (x: { field: Field ; symbol: string }) => Field[]

Type declaration

▸ (x): Field[]

Parameters

Name	Type
x	Object
x.field	Field
x.symbol	string

Returns

Field[]

Inherited from

Struct(TokenSymbolPure).toFields

Defined in

snarky.d.ts:33

---

toInput

▪ Static toInput: (x: { field: Field ; symbol: string }) => { fields?: Field[] ; packed?: [Field, number][] }

Type declaration

▸ (x): Object

Parameters

Name	Type
x	Object
x.field	Field
x.symbol	string

Returns

Object

Name	Type
fields?	Field[]
packed?	[Field, number][]

Inherited from

Struct(TokenSymbolPure).toInput

Defined in

lib/circuit_value.ts:470

---

toJSON

▪ Static toJSON: (x: { field: Field ; symbol: string }) => string

Type declaration

▸ (x): string

Parameters

Name	Type
x	Object
x.field	Field
x.symbol	string

Returns

string

Inherited from

Struct(TokenSymbolPure).toJSON

Defined in

lib/circuit_value.ts:474

Accessors

empty

• Static get empty(): Object

Returns

Object

Name	Type
field	Field
symbol	string

Defined in

lib/hash.ts:172

Methods

from

▸ Static from(symbol): TokenSymbol

Parameters

Name	Type
symbol	string

Returns

TokenSymbol

Defined in

lib/hash.ts:176

---

sizeInFields

▸ Static sizeInFields(): number

Returns

number

Inherited from

Struct(TokenSymbolPure).sizeInFields

Defined in

snarky.d.ts:36