Skip to main content

TokenSymbol

Defined in: lib/provable/crypto/poseidon.ts:248

Extends

  • { field: Field; symbol: string; }

Constructors

new TokenSymbol()

new TokenSymbol(symbol: 
| string
| {
field: Field;
symbol: string;
}): TokenSymbol

Defined in: lib/provable/crypto/poseidon.ts:249

Parameters

symbol

string | { field: Field; symbol: string; }

Returns

TokenSymbol

Overrides

Struct(TokenSymbolPure).constructor

Properties

field

field: Field;

Defined in: lib/provable/crypto/poseidon.ts:202

Inherited from

Struct(TokenSymbolPure).field

symbol

symbol: string;

Defined in: lib/provable/crypto/poseidon.ts:202

Inherited from

Struct(TokenSymbolPure).symbol

_isStruct

static _isStruct: true;

Defined in: lib/provable/types/struct.ts:133

Inherited from

Struct(TokenSymbolPure)._isStruct

check()

static check: (value: {
field: Field;
symbol: string;
}) => void;

Defined in: lib/provable/types/provable-intf.ts:76

Add assertions to the proof to check if value is a valid member of type T. This function does not return anything, instead it creates any number of assertions to prove that value is a valid member of the type T.

For instance, calling check function on the type Bool asserts that the value of the element is either 1 or 0.

Parameters

value

the element of type T to put assertions on.

field

Field

symbol

string

Returns

void

Inherited from

Struct(TokenSymbolPure).check

fromFields()

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

Defined in: lib/provable/types/provable-intf.ts:59

A function that returns an element of type T from the given provable and "auxiliary" data.

This function is the reverse operation of calling toFields and toAuxiliary methods on an element of type T.

Parameters

fields

Field[]

an array of Field elements describing the provable data of the new T element.

aux

any[]

an array of any type describing the "auxiliary" data of the new T element, optional.

Returns

{
field: Field;
symbol: string;
}

An element of type T generated from the given provable and "auxiliary" data.

field
field: Field;
symbol
symbol: string;

Inherited from

Struct(TokenSymbolPure).fromFields

fromJSON()

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

Defined in: lib/provable/types/struct.ts:142

Parameters

x

string

Returns

{
field: Field;
symbol: string;
}
field
field: Field;
symbol
symbol: string;

Inherited from

Struct(TokenSymbolPure).fromJSON

fromValue

static fromValue: (x: 
| string
| {
field: Field;
symbol: string;
}) => {
field: Field;
symbol: string;
} & (value:
| string
| {
field: Field;
symbol: string;
}) => {
field: Field;
symbol: string;
};

Defined in: lib/provable/types/provable-intf.ts:86

Convert provable type from a normal JS type.

Inherited from

Struct(TokenSymbolPure).fromValue

toAuxiliary()

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

Defined in: lib/provable/types/provable-intf.ts:47

A function that takes value (optional), an element of type T, as argument and returns an array of any type that make up the "auxiliary" (non-provable) data of value.

Parameters

value?

the element of type T to generate the auxiliary data array from, optional. If not provided, a default value for auxiliary data is returned.

field

Field

symbol

string

Returns

any[]

An array of any type describing how this T element is made up of "auxiliary" (non-provable) data.

Inherited from

Struct(TokenSymbolPure).toAuxiliary

toCanonical()?

static optional toCanonical: (x: {
field: Field;
symbol: string;
}) => {
field: Field;
symbol: string;
};

Defined in: lib/provable/types/provable-intf.ts:104

Optional method which transforms a provable type into its canonical representation.

This is needed for types that have multiple representations of the same underlying value, and might even not have perfect completeness for some of those representations.

An example is the ForeignField class, which allows non-native field elements to exist in unreduced form. The unreduced form is not perfectly complete, for example, addition of two unreduced field elements can cause a prover error.

Specific protocols need to be able to protect themselves against incomplete operations at all costs. For example, when using actions and reducer, the reducer must be able to produce a proof regardless of the input action. toCanonical() converts any input into a safe form and enables us to handle cases like this generically.

Note: For most types, this method is the identity function. The identity function will also be used when the toCanonical() is not present on a type.

Parameters

x
field

Field

symbol

string

Returns

{
field: Field;
symbol: string;
}
field
field: Field;
symbol
symbol: string;

Inherited from

Struct(TokenSymbolPure).toCanonical

toFields()

static toFields: (value: {
field: Field;
symbol: string;
}) => Field[];

Defined in: lib/provable/types/provable-intf.ts:36

A function that takes value, an element of type T, as argument and returns an array of Field elements that make up the provable data of value.

Parameters

value

the element of type T to generate the Field array from.

field

Field

symbol

string

Returns

Field[]

A Field array describing how this T element is made up of Field elements.

Inherited from

Struct(TokenSymbolPure).toFields

toInput()

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

Defined in: lib/provable/types/struct.ts:137

Parameters

x
field

Field

symbol

string

Returns

{
fields: Field[];
packed: [Field, number][];
}
fields?
optional fields: Field[];
packed?
optional packed: [Field, number][];

Inherited from

Struct(TokenSymbolPure).toInput

toJSON()

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

Defined in: lib/provable/types/struct.ts:141

Parameters

x
field

Field

symbol

string

Returns

string

Inherited from

Struct(TokenSymbolPure).toJSON

toValue()

static toValue: (x: {
field: Field;
symbol: string;
}) => string;

Defined in: lib/provable/types/provable-intf.ts:81

Convert provable type to a normal JS type.

Parameters

x
field

Field

symbol

string

Returns

string

Inherited from

Struct(TokenSymbolPure).toValue

Methods

empty()

static empty(): TokenSymbol

Defined in: lib/provable/crypto/poseidon.ts:268

Returns

TokenSymbol

Overrides

Struct(TokenSymbolPure).empty

from()

static from(value: string | TokenSymbol): TokenSymbol

Defined in: lib/provable/crypto/poseidon.ts:264

Parameters

value

string | TokenSymbol

Returns

TokenSymbol


sizeInFields()

static sizeInFields(): number

Defined in: lib/provable/types/provable-intf.ts:66

Return the size of the T type in terms of Field type, as Field is the primitive type.

Returns

number

A number representing the size of the T type in terms of Field type.

Inherited from

Struct(TokenSymbolPure).sizeInFields