Class BalanceEvent

Event emitted when liquidity balance changed

Hierarchy

  • {
        address: PublicKey;
        amount: Int64;
    }
    • BalanceEvent

Constructors

constructor

Properties

address amount _isStruct check empty fromFields fromJSON fromValue toAuxiliary toCanonical? toFields toInput toJSON toValue

Methods

sizeInFields

Constructors

constructor

Properties

address

address: PublicKey = PublicKey

amount

amount: Int64 = Int64

Static_isStruct

_isStruct

Staticcheck

check: ((value: {
    address: PublicKey;
    amount: Int64;
}) => void)

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.

Type declaration

    • (value): void

    • Parameters

      • value: {
            address: PublicKey;
            amount: Int64;
        }

        the element of type T to put assertions on.

        • address: PublicKey
        • amount: Int64

      Returns void

Staticempty

empty: (() => {
    address: PublicKey;
    amount: Int64;
})

StaticfromFields

fromFields: ((fields: Field[]) => {
    address: PublicKey;
    amount: Int64;
})

StaticfromJSON

fromJSON: ((x: {
    address: string;
    amount: any;
}) => {
    address: PublicKey;
    amount: Int64;
})

StaticfromValue

fromValue: ((x: {
    address: PublicKey;
    amount: Int64;
} | {
    address: {
        isOdd: boolean;
        x: bigint;
    };
    amount: any;
}) => {
    address: PublicKey;
    amount: Int64;
}) & ((value: {
    address: PublicKey | {
        isOdd: boolean | Bool;
        x: bigint | Field;
    };
    amount: any;
}) => {
    address: PublicKey;
    amount: Int64;
})

Convert provable type from a normal JS type.

StatictoAuxiliary

toAuxiliary: ((value?: {
    address: PublicKey;
    amount: Int64;
}) => any[])

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.

Type declaration

    • (value?): any[]

    • Parameters

      • Optionalvalue: {
            address: PublicKey;
            amount: Int64;
        }

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

        • address: PublicKey
        • amount: Int64

      Returns any[]

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

Static OptionaltoCanonical

toCanonical?: ((x: {
    address: PublicKey;
    amount: Int64;
}) => {
    address: PublicKey;
    amount: Int64;
})

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.

StatictoFields

toFields: ((value: {
    address: PublicKey;
    amount: Int64;
}) => Field[])

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.

Type declaration

    • (value): Field[]

    • Parameters

      • value: {
            address: PublicKey;
            amount: Int64;
        }

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

        • address: PublicKey
        • amount: Int64

      Returns Field[]

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

StatictoInput

toInput: ((x: {
    address: PublicKey;
    amount: Int64;
}) => {
    fields?: Field[];
    packed?: [Field, number][];
})

StatictoJSON

toJSON: ((x: {
    address: PublicKey;
    amount: Int64;
}) => {
    address: string;
    amount: any;
})

StatictoValue

toValue: ((x: {
    address: PublicKey;
    amount: Int64;
}) => {
    address: {
        isOdd: boolean;
        x: bigint;
    };
    amount: any;
})

Convert provable type to a normal JS type.

Methods

StaticsizeInFields

  • sizeInFields(): number

  • 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.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods