Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add method to get a ZK signature instead of relying on BCS #13546

Merged
merged 1 commit into from
Sep 6, 2023
Merged

Add method to get a ZK signature instead of relying on BCS #13546

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Add method to get a ZK signature instead of relying on BCS
  • Loading branch information
@Jordan-Mysten
Jordan-Mysten committed Aug 31, 2023
commit b3c87dbe38e351fc909ad99947b70d5cdaacd34c
5 changes: 5 additions & 0 deletions .changeset/curly-lemons-act.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@mysten/zklogin': patch
---

Remove BCS export and introduce new getZkSignature export.
22 changes: 4 additions & 18 deletions apps/wallet/src/background/accounts/zk/ZkAccount.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,9 @@
import {
type SerializedSignature,
type ExportedKeypair,
SIGNATURE_SCHEME_TO_FLAG,
toSerializedSignature,
} from '@mysten/sui.js/cryptography';
import { fromB64, toB64 } from '@mysten/sui.js/utils';
import { computeZkAddress, zkBcs } from '@mysten/zklogin';
import { computeZkAddress, getZkSignature } from '@mysten/zklogin';
import { blake2b } from '@noble/hashes/blake2b';
import { decodeJwt } from 'jose';
import { getCurrentEpoch } from './current-epoch';
Expand Down Expand Up @@ -230,25 +228,13 @@ export class ZkAccount
}
const { ephemeralKeyPair, proofs, maxEpoch } = credentials;
const keyPair = fromExportedKeypair(ephemeralKeyPair);

const userSignature = toSerializedSignature({
signature: await keyPair.sign(digest),
signatureScheme: keyPair.getKeyScheme(),
publicKey: keyPair.getPublicKey(),
});
const bytes = zkBcs
.ser(
'ZkSignature',
{
inputs: proofs,
max_epoch: maxEpoch,
user_signature: fromB64(userSignature),
},
{ maxSize: 2048 },
)
.toBytes();
const signatureBytes = new Uint8Array(bytes.length + 1);
signatureBytes.set([SIGNATURE_SCHEME_TO_FLAG['Zk']]);
signatureBytes.set(bytes, 1);
return toB64(signatureBytes);

return getZkSignature({ inputs: proofs, maxEpoch, userSignature });
}
}
8 changes: 1 addition & 7 deletions sdk/zklogin/src/address.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,7 @@ import { genAddressSeed, toBufferBE } from './utils.js';

export function jwtToAddress(jwt: string, userSalt: bigint) {
const decodedJWT = decodeJwt(jwt);
if (
!decodedJWT.sub ||
!decodedJWT.iss ||
!decodedJWT.aud ||
!decodedJWT.email ||
typeof decodedJWT.email !== 'string'
) {
if (!decodedJWT.sub || !decodedJWT.iss || !decodedJWT.aud) {
throw new Error('Missing jwt data');
}

Expand Down
50 changes: 49 additions & 1 deletion sdk/zklogin/src/bcs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
// Copyright (c) Mysten Labs, Inc.
// SPDX-License-Identifier: Apache-2.0

import { BCS } from '@mysten/bcs';
import { BCS, fromB64, toB64 } from '@mysten/bcs';
import { SIGNATURE_SCHEME_TO_FLAG } from '@mysten/sui.js/cryptography';
import { bcs } from '@mysten/sui.js/bcs';

export const zkBcs = new BCS(bcs);
Expand All @@ -17,6 +18,31 @@ zkBcs.registerStructType('ZkClaim', {
index_mod_4: BCS.U8,
});

type Claim = {
name: string;
value_base64: string;
index_mod_4: number;
};

export interface ProofPoints {
pi_a: string[];
pi_b: string[][];
pi_c: string[];
}

export interface ZkSignatureInputs {
proof_points: ProofPoints;
address_seed: string;
claims: Claim[];
header_base64: string;
}

export interface ZkSignature {
inputs: ZkSignatureInputs;
maxEpoch: number;
userSignature: string | Uint8Array;
}

zkBcs.registerStructType('ZkSignature', {
inputs: {
proof_points: {
Expand All @@ -31,3 +57,25 @@ zkBcs.registerStructType('ZkSignature', {
max_epoch: BCS.U64,
user_signature: [BCS.VECTOR, BCS.U8],
});

function getZkSignatureBytes({ inputs, maxEpoch, userSignature }: ZkSignature) {
return zkBcs
.ser(
'ZkSignature',
{
inputs,
max_epoch: maxEpoch,
user_signature: typeof userSignature === 'string' ? fromB64(userSignature) : userSignature,
},
{ maxSize: 2048 },
)
.toBytes();
}

export function getZkSignature({ inputs, maxEpoch, userSignature }: ZkSignature) {
const bytes = getZkSignatureBytes({ inputs, maxEpoch, userSignature });
const signatureBytes = new Uint8Array(bytes.length + 1);
signatureBytes.set([SIGNATURE_SCHEME_TO_FLAG['Zk']]);
signatureBytes.set(bytes, 1);
return toB64(signatureBytes);
}
2 changes: 1 addition & 1 deletion sdk/zklogin/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
export { computeZkAddress, jwtToAddress } from './address.js';
export type { ComputeZKAddressOptions } from './address.js';

export { zkBcs } from './bcs.js';
export { getZkSignature } from './bcs.js';

export { poseidonHash } from './poseidon.js';

Expand Down