@aptos-labs/ts-sdk - v6.0.0
    Preparing search index...

    Interface WeierstrassPoint<T>

    Instance methods for 3D XYZ projective points.

    interface WeierstrassPoint<T> {
        px: T;
        py: T;
        pz: T;
        X: T;
        Y: T;
        Z: T;
        get x(): T;
        get y(): T;
        _setWindowSize(windowSize: number): void;
        add(other: WeierstrassPoint): WeierstrassPoint;
        assertValidity(): void;
        clearCofactor(): WeierstrassPoint;
        double(): WeierstrassPoint;
        equals(other: WeierstrassPoint): boolean;
        hasEvenY(): boolean;
        is0(): boolean;
        isSmallOrder(): boolean;
        isTorsionFree(): boolean;
        multiply(scalar: bigint): WeierstrassPoint;
        multiplyAndAddUnsafe(
            Q: WeierstrassPoint<T>,
            a: bigint,
            b: bigint,
        ): WeierstrassPoint<T> | undefined;
        multiplyUnsafe(scalar: bigint): WeierstrassPoint;
        negate(): WeierstrassPoint;
        precompute(windowSize?: number, isLazy?: boolean): WeierstrassPoint;
        subtract(other: WeierstrassPoint): WeierstrassPoint;
        toAffine(invertedZ?: T): AffinePoint<T>;
        toBytes(isCompressed?: boolean): Uint8Array;
        toHex(isCompressed?: boolean): string;
        toRawBytes(isCompressed?: boolean): Uint8Array;
    }

    Type Parameters

    • T

    Hierarchy (View Summary)

    Index

    Accessors

    x y

    Methods

    _setWindowSize add assertValidity clearCofactor double equals hasEvenY is0 isSmallOrder isTorsionFree multiply multiplyAndAddUnsafe multiplyUnsafe negate precompute subtract toAffine toBytes toHex toRawBytes

    Properties

    px py pz X Y Z

    Accessors

    • get x(): T

      affine x coordinate. Different from projective X.

      Returns T

    • get y(): T

      affine y coordinate. Different from projective Y.

      Returns T

    Methods

    _setWindowSize

    • _setWindowSize(windowSize: number): void

      Parameters

      • windowSize: number

      Returns void

      use p.precompute(windowSize)

    • Returns void

    • Returns boolean

      use p.y % 2n === 0n

    • Returns boolean

    • Returns boolean

    • Returns boolean

    • Parameters

      Returns WeierstrassPoint<T> | undefined

      use multiplyUnsafe

    • Massively speeds up p.multiply(n) by using precompute tables (caching). See wNAF.

      Parameters

      • OptionalwindowSize: number
      • OptionalisLazy: boolean

        calculate cache now. Default (true) ensures it's deferred to first multiply()

      Returns WeierstrassPoint

    • Converts point to 2D xy affine coordinates

      Parameters

      • OptionalinvertedZ: T

      Returns AffinePoint<T>

    • Encodes point using IEEE P1363 (DER) encoding. First byte is 2/3/4. Default = isCompressed.

      Parameters

      • OptionalisCompressed: boolean

      Returns Uint8Array

    • Parameters

      • OptionalisCompressed: boolean

      Returns string

    • Parameters

      • OptionalisCompressed: boolean

      Returns Uint8Array

      use toBytes

    Properties

    px: T

    use .X

    py: T

    use .Y

    pz: T

    use .Z

    X: T

    projective X coordinate. Different from affine x.

    Y: T

    projective Y coordinate. Different from affine y.

    Z: T

    projective z coordinate

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods
    Properties