Skip to content

Commit

Permalink
Fix readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
paulmillr committed Dec 3, 2020
1 parent 806340f commit 1b623ca
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,15 +142,15 @@ function verifyBatch(
##### `pairing(G1Point, G2Point)`
```typescript
function pairing(
g1Point: Point<bigint>,
g2Point: Point<[bigint, bigint]>,
g1Point: PointG1,
g2Point: PointG2,
withFinalExponent: boolean = true
): Point<[bigint, bigint, bigint, bigint, bigint, bigint, bigint, bigint, bigint, bigint, bigint, bigint]>
): Fq12
```
- `g1Point: Point<bigint>` - simple point, `x, y` are bigints
- `g2Point: Point<[bigint, bigint]>` - point over curve with imaginary numbers (`(x, x_1), (y, y_1)`)
- `g1Point: PointG1` - simple point, `x, y` are bigints
- `g2Point: PointG2` - point over curve with imaginary numbers (`(x, x_1), (y, y_1)`)
- `withFinalExponent: boolean` - should the result be powered by curve order. Very slow.
- Returns `Point<BigintTwelve>`: paired point over 12-degree extension field.
- Returns `Fq12`: paired point over 12-degree extension field.

##### Helpers

Expand All @@ -177,7 +177,6 @@ bls.Fq2
bls.Fq12
bls.G1Point
bls.G2Point
bls.G12Point
```

## Internals
Expand Down

0 comments on commit 1b623ca

Please sign in to comment.