Class Prio3<Measurement, AggregateResult>

Type Parameters

Measurement
AggregateResult

Hierarchy (View Summary)

Vdaf<
    Measurement,
    AggregationParameter,
    PublicShare,
    InputShare,
    OutputShare,
    AggregatorShare,
    AggregateResult,
    PreparationState,
    PreparationShare,
    PreparationMessage,
>
- Prio3

Constructors

constructor

new Prio3<Measurement, AggregateResult>(
    xof: XofConstructor,
    flp: Flp<Measurement, AggregateResult>,
    shares: number,
    proofs: number,
    id: number,
): Prio3<Measurement, AggregateResult>
Type Parameters
- Measurement
- AggregateResult
Parameters
- xof: XofConstructor
- flp: Flp<Measurement, AggregateResult>
- shares: number
- proofs: number
- id: number
Returns Prio3<Measurement, AggregateResult>
Overrides Vdaf.constructor
- Defined in packages/prio3/dist/prio3.d.ts:41

Properties

`Readonly`flp

flp: Flp<Measurement, AggregateResult>

`Readonly`id

id: number

`Readonly`nonceSize

nonceSize: 16

`Readonly`proofs

proofs: number

`Readonly`randSize

randSize: number

`Readonly`rounds

rounds: 1

`Readonly`shares

shares: number

`Readonly`verifyKeySize

verifyKeySize: number

`Readonly`xof

xof: XofConstructor

Methods

aggregate

aggregate(
_aggregationParameter: null,
outputShares: OutputShare[],
): AggregatorShare
Parameters
- _aggregationParameter: null
- outputShares: OutputShare[]
Returns AggregatorShare
Overrides Vdaf.aggregate
- Defined in packages/prio3/dist/prio3.d.ts:58

domainSeparationTag

domainSeparationTag(usage: number): Buffer
Parameters
- usage: number
Returns Buffer
Inherited from Vdaf.domainSeparationTag
- Defined in packages/vdaf/dist/index.d.ts:36

encodeAggregationParameter

encodeAggregationParameter(_: null): Buffer
Parameters
- _: null
Returns Buffer
Overrides Vdaf.encodeAggregationParameter
- Defined in packages/prio3/dist/prio3.d.ts:65

encodeAggregatorShare

encodeAggregatorShare(aggregatorShare: bigint[]): Buffer
Parameters
- aggregatorShare: bigint[]
Returns Buffer
Overrides Vdaf.encodeAggregatorShare
- Defined in packages/prio3/dist/prio3.d.ts:62

encodeInputShare

encodeInputShare(__namedParameters: InputShare): Buffer
Parameters
- __namedParameters: InputShare
Returns Buffer
Overrides Vdaf.encodeInputShare
- Defined in packages/prio3/dist/prio3.d.ts:60

encodePreparationMessage

encodePreparationMessage(__namedParameters: PreparationMessage): Buffer
Parameters
- __namedParameters: PreparationMessage
Returns Buffer
Overrides Vdaf.encodePreparationMessage
- Defined in packages/prio3/dist/prio3.d.ts:64

encodePreparationShare

encodePreparationShare(__namedParameters: PreparationShare): Buffer
Parameters
- __namedParameters: PreparationShare
Returns Buffer
Overrides Vdaf.encodePreparationShare
- Defined in packages/prio3/dist/prio3.d.ts:63

encodePublicShare

encodePublicShare(__namedParameters: PublicShare): Buffer
Parameters
- __namedParameters: PublicShare
Returns Buffer
Overrides Vdaf.encodePublicShare
- Defined in packages/prio3/dist/prio3.d.ts:61

encodeTestVectorAggregatorShare

encodeTestVectorAggregatorShare(aggregatorShare: AggregatorShare): string
Parameters
- aggregatorShare: AggregatorShare
Returns string
Inherited from Vdaf.encodeTestVectorAggregatorShare
- Defined in packages/vdaf/dist/index.d.ts:53

encodeTestVectorInputShare

encodeTestVectorInputShare(inputShare: InputShare): string
Parameters
- inputShare: InputShare
Returns string
Inherited from Vdaf.encodeTestVectorInputShare
- Defined in packages/vdaf/dist/index.d.ts:51

encodeTestVectorOutputShare

encodeTestVectorOutputShare(outputShare: bigint[]): string[]
Parameters
- outputShare: bigint[]
Returns string[]
Overrides Vdaf.encodeTestVectorOutputShare
- Defined in packages/prio3/dist/prio3.d.ts:66

encodeTestVectorPreparationMessage

encodeTestVectorPreparationMessage(
preparationMessage: PreparationMessage,
): string
Parameters
- preparationMessage: PreparationMessage
Returns string
Inherited from Vdaf.encodeTestVectorPreparationMessage
- Defined in packages/vdaf/dist/index.d.ts:55

encodeTestVectorPreparationShare

encodeTestVectorPreparationShare(preparationShare: PreparationShare): string
Parameters
- preparationShare: PreparationShare
Returns string
Inherited from Vdaf.encodeTestVectorPreparationShare
- Defined in packages/vdaf/dist/index.d.ts:54

encodeTestVectorPublicShare

encodeTestVectorPublicShare(publicShare: PublicShare): string
Parameters
- publicShare: PublicShare
Returns string
Inherited from Vdaf.encodeTestVectorPublicShare
- Defined in packages/vdaf/dist/index.d.ts:52

isValid

isValid(
_aggregationParameter: null,
previousAggregationParameters: null[],
): boolean
Parameters
- _aggregationParameter: null
- previousAggregationParameters: null[]
Returns boolean
Overrides Vdaf.isValid
- Defined in packages/prio3/dist/prio3.d.ts:42

prepareInit

prepareInit(
    verifyKey: Buffer,
    aggregatorId: number,
    _aggregationParameter: null,
    nonce: Buffer,
    __namedParameters: PublicShare,
    __namedParameters: InputShare,
): Promise<
    {
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    },
>
Parameters
- verifyKey: Buffer
- aggregatorId: number
- _aggregationParameter: null
- nonce: Buffer
- __namedParameters: PublicShare
- __namedParameters: InputShare
Returns Promise<
    {
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    },
>
Overrides Vdaf.prepareInit
- Defined in packages/prio3/dist/prio3.d.ts:47

prepareNext

prepareNext(
    preparationState: PreparationState,
    preparationMessage: PreparationMessage,
):
    | {
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }
    | { outputShare: OutputShare }
Parameters
- preparationState: PreparationState
- preparationMessage: PreparationMessage
Returns
    | {
        preparationShare: PreparationShare;
        preparationState: PreparationState;
    }
    | { outputShare: OutputShare }
Overrides Vdaf.prepareNext
- Defined in packages/prio3/dist/prio3.d.ts:51

run

run(
    __namedParameters: {
        aggregationParameter: null;
        measurements: Measurement[];
        nonces?: Buffer[];
        rands?: Buffer[];
        verifyKey?: Buffer;
    },
): Promise<TestVector<null, Measurement, AggregateResult>>
Parameters
- __namedParameters: {
      aggregationParameter: null;
      measurements: Measurement[];
      nonces?: Buffer[];
      rands?: Buffer[];
      verifyKey?: Buffer;
  }
Returns Promise<TestVector<null, Measurement, AggregateResult>>
Inherited from Vdaf.run
- Defined in packages/vdaf/dist/index.d.ts:37

shard

shard(
    measurement: Measurement,
    nonce: Buffer,
    rand: Buffer,
): Promise<{ inputShares: InputShare[]; publicShare: PublicShare }>
Parameters
- measurement: Measurement
- nonce: Buffer
- rand: Buffer
Returns Promise<{ inputShares: InputShare[]; publicShare: PublicShare }>
Overrides Vdaf.shard
- Defined in packages/prio3/dist/prio3.d.ts:43

shardEncoded

shardEncoded(
    measurement: Measurement,
    nonce: Buffer,
    rand: Buffer,
): Promise<{ inputShares: Buffer[]; publicShare: Buffer }>
Parameters
- measurement: Measurement
- nonce: Buffer
- rand: Buffer
Returns Promise<{ inputShares: Buffer[]; publicShare: Buffer }>
Inherited from Vdaf.shardEncoded
- Defined in packages/vdaf/dist/index.d.ts:18

test

test(
aggregationParameter: null,
measurements: Measurement[],
): Promise<AggregateResult>
Parameters
- aggregationParameter: null
- measurements: Measurement[]
Returns Promise<AggregateResult>
Inherited from Vdaf.test
- Defined in packages/vdaf/dist/index.d.ts:50

unshard

unshard(
    _aggregationParameter: null,
    aggregatorShares: AggregatorShare[],
    measurementCount: number,
): AggregateResult
Parameters
- _aggregationParameter: null
- aggregatorShares: AggregatorShare[]
- measurementCount: number
Returns AggregateResult
Overrides Vdaf.unshard
- Defined in packages/prio3/dist/prio3.d.ts:59

unshardPreparationShares

unshardPreparationShares(
_aggregationParameter: null,
preparationShares: PreparationShare[],
): Promise<PreparationMessage>
Parameters
- _aggregationParameter: null
- preparationShares: PreparationShare[]
Returns Promise<PreparationMessage>
Overrides Vdaf.unshardPreparationShares
- Defined in packages/prio3/dist/prio3.d.ts:57

Class Prio3<Measurement, AggregateResult>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Prio3<Measurement, AggregateResult>

Properties

Readonlyflp

Readonlyid

ReadonlynonceSize

Readonlyproofs

ReadonlyrandSize

Readonlyrounds

Readonlyshares

ReadonlyverifyKeySize

Readonlyxof

Methods

aggregate

Parameters

Returns AggregatorShare

domainSeparationTag

Parameters

Returns Buffer

encodeAggregationParameter

Parameters

Returns Buffer

encodeAggregatorShare

Parameters

Returns Buffer

encodeInputShare

Parameters

Returns Buffer

encodePreparationMessage

Parameters

Returns Buffer

encodePreparationShare

Parameters

Returns Buffer

encodePublicShare

Parameters

Returns Buffer

encodeTestVectorAggregatorShare

Parameters

Returns string

encodeTestVectorInputShare

Parameters

Returns string

encodeTestVectorOutputShare

Parameters

Returns string[]

encodeTestVectorPreparationMessage

Parameters

Returns string

encodeTestVectorPreparationShare

Parameters

Returns string

encodeTestVectorPublicShare

Parameters

Returns string

isValid

Parameters

Returns boolean

prepareInit

Parameters

Returns Promise< { preparationShare: PreparationShare; preparationState: PreparationState; },>

prepareNext

Parameters

Returns | { preparationShare: PreparationShare; preparationState: PreparationState; } | { outputShare: OutputShare }

run

Parameters

Returns Promise<TestVector<null, Measurement, AggregateResult>>

shard

Parameters

Returns Promise<{ inputShares: InputShare[]; publicShare: PublicShare }>

`Readonly`flp

`Readonly`id

`Readonly`nonceSize

`Readonly`proofs

`Readonly`randSize

`Readonly`rounds

`Readonly`shares

`Readonly`verifyKeySize

`Readonly`xof

Returns Promise<
{
preparationShare: PreparationShare;
preparationState: PreparationState;
},
>

Returns
| {
preparationShare: PreparationShare;
preparationState: PreparationState;
}
| { outputShare: OutputShare }