Skip to main content

Class: TokenSymbol

Hierarchy

  • { field: Field ; symbol: string }

    TokenSymbol

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new TokenSymbol(value)

Parameters

NameType
valueObject
value.fieldField
value.symbolstring

Inherited from

Struct(TokenSymbolPure).constructor

Defined in

lib/circuit_value.ts:728

Properties

field

field: Field

Inherited from

Struct(TokenSymbolPure).field

Defined in

lib/hash.ts:122


symbol

symbol: string

Inherited from

Struct(TokenSymbolPure).symbol

Defined in

lib/hash.ts:122


check

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

Type declaration

▸ (x): void

Parameters
NameType
xObject
x.fieldField
x.symbolstring
Returns

void

Inherited from

Struct(TokenSymbolPure).check

Defined in

snarky.d.ts:29


fromFields

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

Type declaration

▸ (x, aux): Object

Parameters
NameType
xField[]
auxany[]
Returns

Object

NameType
fieldField
symbolstring

Inherited from

Struct(TokenSymbolPure).fromFields

Defined in

snarky.d.ts:27


fromJSON

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

Type declaration

▸ (x): Object

Parameters
NameType
xstring
Returns

Object

NameType
fieldField
symbolstring

Inherited from

Struct(TokenSymbolPure).fromJSON

Defined in

lib/circuit_value.ts:735


toAuxiliary

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

Type declaration

▸ (x?): any[]

Parameters
NameType
x?Object
x.fieldField
x.symbolstring
Returns

any[]

Inherited from

Struct(TokenSymbolPure).toAuxiliary

Defined in

snarky.d.ts:26


toFields

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

Type declaration

▸ (x): Field[]

Parameters
NameType
xObject
x.fieldField
x.symbolstring
Returns

Field[]

Inherited from

Struct(TokenSymbolPure).toFields

Defined in

snarky.d.ts:25


toInput

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

Type declaration

▸ (x): Object

Parameters
NameType
xObject
x.fieldField
x.symbolstring
Returns

Object

NameType
fields?Field[]
packed?[Field, number][]

Inherited from

Struct(TokenSymbolPure).toInput

Defined in

lib/circuit_value.ts:730


toJSON

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

Type declaration

▸ (x): string

Parameters
NameType
xObject
x.fieldField
x.symbolstring
Returns

string

Inherited from

Struct(TokenSymbolPure).toJSON

Defined in

lib/circuit_value.ts:734

Accessors

empty

Static get empty(): Object

Returns

Object

NameType
fieldField
symbolstring

Defined in

lib/hash.ts:153

Methods

from

Static from(symbol): TokenSymbol

Parameters

NameType
symbolstring

Returns

TokenSymbol

Defined in

lib/hash.ts:157


sizeInFields

Static sizeInFields(): number

Returns

number

Inherited from

Struct(TokenSymbolPure).sizeInFields

Defined in

snarky.d.ts:28