Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
66 changes: 26 additions & 40 deletions docs/guides/2_integrating_aligned_into_your_application.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -116,12 +116,13 @@ The proof submission and verification can be done either with the SDK or by usin

#### Using the SDK

To submit a proof using the SDK, you can use the `submit` function, and then you can use the `verify_proof_onchain` function to check if the proof was correctly verified in Aligned.

To submit a proof using the SDK, you can use the `submit_and_wait_verification` function.
This function submits the proof to aligned and waits for it to be verified in Aligned.
Alternatively you can call `submit` if you dont want to wait for proof verification.
The following code is an example of how to submit a proof using the SDK:

```rust
use aligned_sdk::sdk::{submit, get_next_nonce};
use aligned_sdk::sdk::{submit_and_wait_verification, get_next_nonce};
use aligned_sdk::types::{ProvingSystemId, VerificationData};
use ethers::prelude::*;

Expand All@@ -147,13 +148,33 @@ async fn submit_proof_to_aligned(
.await
.map_err(|e| anyhow::anyhow!("Failed to get next nonce: {:?}", e))?;

submit(BATCHER_URL, &verification_data, wallet, nonce).await
.map_err(|e| anyhow::anyhow!("Failed to submit proof: {:?}", e))
match submit_and_wait_verification(
BATCHER_URL,
&rpc_url,
Chain::Holesky,
&verification_data,
wallet.clone(),
nonce,
BATCHER_PAYMENTS_ADDRESS
)

submit_and_wait_verification(
BATCHER_URL,
RPC_URL,
Chain::Holesky,
&verification_data,
wallet,
nonce,
BATCHER_CONTRACT_ADDRESS
).await.map_err(|e| anyhow::anyhow!("Failed to submit proof: {:?}", e))
}

#[tokio::main]
async fn main() {
let wallet = // Initialize wallet

let wallet = wallet.with_chain_id(17000u64)

let proof = // Generate or obtain proof

match submit_proof_to_aligned(proof, wallet).await {
Expand All@@ -163,41 +184,6 @@ async fn main() {
}
```

The following code is an example of how to verify the proof was correctly verified in Aligned using the SDK:

```rust
use aligned_sdk::sdk::verify_proof_onchain;
use aligned_sdk::types::{AlignedVerificationData, Chain};
use ethers::prelude::*;
use tokio::time::{sleep, Duration};

async fn wait_for_proof_verification(
aligned_verification_data: AlignedVerificationData,
rpc_url: String,
) -> Result<(), anyhow::Error> {
for _ in 0..10 {
if verify_proof_onchain(aligned_verification_data.clone(), Chain::Holesky, rpc_url.as_str()).await.is_ok_and(|r| r) {
println!("Proof verified successfully.");
return Ok(());
}
println!("Proof not verified yet. Waiting 10 seconds before checking again...");
sleep(Duration::from_secs(10)).await;
}
anyhow::bail!("Proof verification failed")
}

#[tokio::main]
async fn main() {
let aligned_verification_data = // Obtain aligned verification data
let rpc_url = "https://ethereum-holesky-rpc.publicnode.com".to_string();

match wait_for_proof_verification(aligned_verification_data, rpc_url).await {
Ok(_) => println!("Proof verified"),
Err(err) => println!("Error: {:?}", err),
}
}
```

You can find an example of the proof submission and verification in the [ZKQuiz Program](../../examples/zkquiz/quiz/script/src/main.rs).

This example generates a proof, instantiates a wallet to submit the proof, and then submits the proof to Aligned for verification. It then waits for the proof to be verified in Aligned.
Expand Down
2 changes: 1 addition & 1 deletion examples/zkquiz/Makefile
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
deploy_verifier:
@. ./contracts/.env && . ./contracts/deploy.sh

CONTRACT_ADDRESS=0x8dB9e6f1393c3486F30181d606312ec632189621
CONTRACT_ADDRESS=0xA828f1463074d26FB761c662F80194f5dB2d31D0
RPC_URL=https://ethereum-holesky-rpc.publicnode.com
VERIFICATION_DATA=./aligned_verification_data/0a1fab5df88a71e48633cbdeedc8d1a234b790d15a8a2fd04cd6a03c1e05b5ef_212.json

Expand Down
1 change: 1 addition & 0 deletions examples/zkquiz/contracts/.env.example
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
RPC_URL=<rpc_url>
PRIVATE_KEY=<private_key>
ALIGNED_SERVICE_MANAGER_ADDRESS=<aligned_service_manager_addr># 0x58F280BeBE9B34c9939C3C39e0890C81f163B623 for Holesky
BATCHER_PAYMENT_SERVICE_ADDRESS=<batcher_payment_service_addr># 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
ETHERSCAN_API_KEY=<etherscan_api_key>
9 changes: 7 additions & 2 deletions examples/zkquiz/contracts/deploy.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,11 @@ if [ -z "$ALIGNED_SERVICE_MANAGER_ADDRESS" ]; then
exit 1
fi

if [ -z "$BATCHER_PAYMENT_SERVICE_ADDRESS" ]; then
echo "BATCHER_PAYMENT_SERVICE_ADDRESS is not set. Please set it in .env"
exit 1
fi

if [ -z "$RPC_URL" ]; then
echo "RPC_URL is not set. Please set it in .env"
exit 1
Expand All@@ -24,8 +29,8 @@ fi
forge install

forge script script/Deployer.s.sol \
"$ALIGNED_SERVICE_MANAGER_ADDRESS" \
"$ALIGNED_SERVICE_MANAGER_ADDRESS" "$BATCHER_PAYMENT_SERVICE_ADDRESS" \
--rpc-url "$RPC_URL" \
--private-key "$PRIVATE_KEY" \
--broadcast \
--sig "run(address _alignedServiceManager)"
--sig "run(address _alignedServiceManager, address _paymentService)"
10 changes: 8 additions & 2 deletions examples/zkquiz/contracts/script/Deployer.s.sol
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,16 @@ import {VerifierContract} from "../src/VerifierContract.sol";
contract CounterScript is Script {
function setUp() public {}

function run(address _targetContract) external returns (address) {
function run(
address _alignedServiceManager,
address _paymentService
) external returns (address) {
vm.startBroadcast();

VerifierContract verifyBatchInclusionCaller = new VerifierContract(_targetContract);
VerifierContract verifyBatchInclusionCaller = new VerifierContract(
_alignedServiceManager,
_paymentService
);

vm.stopBroadcast();

Expand Down
62 changes: 44 additions & 18 deletions examples/zkquiz/contracts/src/VerifierContract.sol
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,14 +8,20 @@ contract VerifierContract is ERC721URIStorage {
uint256 private _nextTokenId;

address public alignedServiceManager;
address public paymentServiceAddr;

bytes32 public elfCommitment = 0x35dd40ab04e180712996495caec915b8a7c488433acbb50c4d8d912cb55bf1f1;
bytes32 public elfCommitment =
0x35dd40ab04e180712996495caec915b8a7c488433acbb50c4d8d912cb55bf1f1;

// map to check if proof has already been submitted
mapping(bytes32 => bool) public mintedProofs;

constructor(address _alignedServiceManager) ERC721("Aligned Layer ZK Quiz", "AZKQ") {
constructor(
address _alignedServiceManager,
address _paymentServiceAddr
) ERC721("Aligned Layer ZK Quiz", "AZKQ") {
alignedServiceManager = _alignedServiceManager;
paymentServiceAddr = _paymentServiceAddr;
}

function verifyBatchInclusion(
Expand All@@ -27,25 +33,41 @@ contract VerifierContract is ERC721URIStorage {
bytes memory merkleProof,
uint256 verificationDataBatchIndex
) external returns (uint256) {
require(elfCommitment == provingSystemAuxDataCommitment, "ELF does not match");
require(address(proofGeneratorAddr) == msg.sender, "proofGeneratorAddr does not match");

bytes32 fullHash = keccak256(abi.encodePacked(proofCommitment,
pubInputCommitment, provingSystemAuxDataCommitment, proofGeneratorAddr));
require(!mintedProofs[fullHash], "proof already minted");
require(
elfCommitment == provingSystemAuxDataCommitment,
"ELF does not match"
);
require(
address(proofGeneratorAddr) == msg.sender,
"proofGeneratorAddr does not match"
);

(bool callWasSuccessfull, bytes memory proofIsIncluded) = alignedServiceManager.staticcall(
abi.encodeWithSignature(
"verifyBatchInclusion(bytes32,bytes32,bytes32,bytes20,bytes32,bytes,uint256)",
bytes32 fullHash = keccak256(
abi.encodePacked(
proofCommitment,
pubInputCommitment,
provingSystemAuxDataCommitment,
proofGeneratorAddr,
batchMerkleRoot,
merkleProof,
verificationDataBatchIndex
proofGeneratorAddr
)
);
require(!mintedProofs[fullHash], "proof already minted");

(
bool callWasSuccessfull,
bytes memory proofIsIncluded
) = alignedServiceManager.staticcall(
abi.encodeWithSignature(
"verifyBatchInclusion(bytes32,bytes32,bytes32,bytes20,bytes32,bytes,uint256,address)",
proofCommitment,
pubInputCommitment,
provingSystemAuxDataCommitment,
proofGeneratorAddr,
batchMerkleRoot,
merkleProof,
verificationDataBatchIndex,
paymentServiceAddr
)
);

require(callWasSuccessfull, "static_call failed");

Expand All@@ -56,15 +78,19 @@ contract VerifierContract is ERC721URIStorage {

uint256 tokenId = _nextTokenId++;
_mint(msg.sender, tokenId);
_setTokenURI(tokenId, "ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ");
_setTokenURI(
tokenId,
"ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ"
);

return tokenId;
}

function tokenURI(uint256 tokenId) public override view virtual returns (string memory) {
function tokenURI(
uint256 tokenId
) public view virtual override returns (string memory) {
_requireOwned(tokenId);

return "ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ";
}

}
4 changes: 3 additions & 1 deletion examples/zkquiz/quiz/program/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,4 +6,6 @@ edition = "2021"

[dependencies]
sp1-zkvm = { git = "https://github.com/succinctlabs/sp1.git", rev = "v1.0.8-testnet" }
tiny-keccak = { git = "https://github.com/sp1-patches/tiny-keccak", branch = "patch-v2.0.2", features = ["sha3"] }
tiny-keccak = { git = "https://github.com/sp1-patches/tiny-keccak", branch = "patch-v2.0.2", features = [
"sha3",
] }
52 changes: 51 additions & 1 deletion examples/zkquiz/quiz/script/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/zkquiz/quiz/script/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ edition = "2021"

[dependencies]
sp1-sdk = { git = "https://github.com/succinctlabs/sp1.git", rev = "v1.0.1" }
aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", tag = "v0.4.0" }
aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", rev = "6908110aaa04ec3107f15ab8a8bb2603e7bbead9" }
ethers = { tag = "v2.0.15-fix-reconnections", features = [
"ws",
"rustls",
Expand Down
2 changes: 1 addition & 1 deletion examples/zkquiz/quiz/script/VerifierContract.json

Large diffs are not rendered by default.

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
66 changes: 26 additions & 40 deletions docs/guides/2_integrating_aligned_into_your_application.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -116,12 +116,13 @@ The proof submission and verification can be done either with the SDK or by usin

#### Using the SDK

To submit a proof using the SDK, you can use the `submit` function, and then you can use the `verify_proof_onchain` function to check if the proof was correctly verified in Aligned.

To submit a proof using the SDK, you can use the `submit_and_wait_verification` function.
This function submits the proof to aligned and waits for it to be verified in Aligned.
Alternatively you can call `submit` if you dont want to wait for proof verification.
The following code is an example of how to submit a proof using the SDK:

```rust
use aligned_sdk::sdk::{submit, get_next_nonce};
use aligned_sdk::sdk::{submit_and_wait_verification, get_next_nonce};
use aligned_sdk::types::{ProvingSystemId, VerificationData};
use ethers::prelude::*;

Expand All@@ -147,13 +148,33 @@ async fn submit_proof_to_aligned(
.await
.map_err(|e| anyhow::anyhow!("Failed to get next nonce: {:?}", e))?;

submit(BATCHER_URL, &verification_data, wallet, nonce).await
.map_err(|e| anyhow::anyhow!("Failed to submit proof: {:?}", e))
match submit_and_wait_verification(
BATCHER_URL,
&rpc_url,
Chain::Holesky,
&verification_data,
wallet.clone(),
nonce,
BATCHER_PAYMENTS_ADDRESS
)

submit_and_wait_verification(
BATCHER_URL,
RPC_URL,
Chain::Holesky,
&verification_data,
wallet,
nonce,
BATCHER_CONTRACT_ADDRESS
).await.map_err(|e| anyhow::anyhow!("Failed to submit proof: {:?}", e))
}

#[tokio::main]
async fn main() {
let wallet = // Initialize wallet

let wallet = wallet.with_chain_id(17000u64)

let proof = // Generate or obtain proof

match submit_proof_to_aligned(proof, wallet).await {
Expand All@@ -163,41 +184,6 @@ async fn main() {
}
```

The following code is an example of how to verify the proof was correctly verified in Aligned using the SDK:

```rust
use aligned_sdk::sdk::verify_proof_onchain;
use aligned_sdk::types::{AlignedVerificationData, Chain};
use ethers::prelude::*;
use tokio::time::{sleep, Duration};

async fn wait_for_proof_verification(
aligned_verification_data: AlignedVerificationData,
rpc_url: String,
) -> Result<(), anyhow::Error> {
for _ in 0..10 {
if verify_proof_onchain(aligned_verification_data.clone(), Chain::Holesky, rpc_url.as_str()).await.is_ok_and(|r| r) {
println!("Proof verified successfully.");
return Ok(());
}
println!("Proof not verified yet. Waiting 10 seconds before checking again...");
sleep(Duration::from_secs(10)).await;
}
anyhow::bail!("Proof verification failed")
}

#[tokio::main]
async fn main() {
let aligned_verification_data = // Obtain aligned verification data
let rpc_url = "https://ethereum-holesky-rpc.publicnode.com".to_string();

match wait_for_proof_verification(aligned_verification_data, rpc_url).await {
Ok(_) => println!("Proof verified"),
Err(err) => println!("Error: {:?}", err),
}
}
```

You can find an example of the proof submission and verification in the [ZKQuiz Program](../../examples/zkquiz/quiz/script/src/main.rs).

This example generates a proof, instantiates a wallet to submit the proof, and then submits the proof to Aligned for verification. It then waits for the proof to be verified in Aligned.
Expand Down
2 changes: 1 addition & 1 deletion examples/zkquiz/Makefile
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
deploy_verifier:
@. ./contracts/.env && . ./contracts/deploy.sh

CONTRACT_ADDRESS=0x8dB9e6f1393c3486F30181d606312ec632189621
CONTRACT_ADDRESS=0xA828f1463074d26FB761c662F80194f5dB2d31D0
RPC_URL=https://ethereum-holesky-rpc.publicnode.com
VERIFICATION_DATA=./aligned_verification_data/0a1fab5df88a71e48633cbdeedc8d1a234b790d15a8a2fd04cd6a03c1e05b5ef_212.json

Expand Down
1 change: 1 addition & 0 deletions examples/zkquiz/contracts/.env.example
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
RPC_URL=<rpc_url>
PRIVATE_KEY=<private_key>
ALIGNED_SERVICE_MANAGER_ADDRESS=<aligned_service_manager_addr># 0x58F280BeBE9B34c9939C3C39e0890C81f163B623 for Holesky
BATCHER_PAYMENT_SERVICE_ADDRESS=<batcher_payment_service_addr># 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
ETHERSCAN_API_KEY=<etherscan_api_key>
9 changes: 7 additions & 2 deletions examples/zkquiz/contracts/deploy.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,11 @@ if [ -z "$ALIGNED_SERVICE_MANAGER_ADDRESS" ]; then
exit 1
fi

if [ -z "$BATCHER_PAYMENT_SERVICE_ADDRESS" ]; then
echo "BATCHER_PAYMENT_SERVICE_ADDRESS is not set. Please set it in .env"
exit 1
fi

if [ -z "$RPC_URL" ]; then
echo "RPC_URL is not set. Please set it in .env"
exit 1
Expand All@@ -24,8 +29,8 @@ fi
forge install

forge script script/Deployer.s.sol \
"$ALIGNED_SERVICE_MANAGER_ADDRESS" \
"$ALIGNED_SERVICE_MANAGER_ADDRESS" "$BATCHER_PAYMENT_SERVICE_ADDRESS" \
--rpc-url "$RPC_URL" \
--private-key "$PRIVATE_KEY" \
--broadcast \
--sig "run(address _alignedServiceManager)"
--sig "run(address _alignedServiceManager, address _paymentService)"
10 changes: 8 additions & 2 deletions examples/zkquiz/contracts/script/Deployer.s.sol
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,16 @@ import {VerifierContract} from "../src/VerifierContract.sol";
contract CounterScript is Script {
function setUp() public {}

function run(address _targetContract) external returns (address) {
function run(
address _alignedServiceManager,
address _paymentService
) external returns (address) {
vm.startBroadcast();

VerifierContract verifyBatchInclusionCaller = new VerifierContract(_targetContract);
VerifierContract verifyBatchInclusionCaller = new VerifierContract(
_alignedServiceManager,
_paymentService
);

vm.stopBroadcast();

Expand Down
62 changes: 44 additions & 18 deletions examples/zkquiz/contracts/src/VerifierContract.sol
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,14 +8,20 @@ contract VerifierContract is ERC721URIStorage {
uint256 private _nextTokenId;

address public alignedServiceManager;
address public paymentServiceAddr;

bytes32 public elfCommitment = 0x35dd40ab04e180712996495caec915b8a7c488433acbb50c4d8d912cb55bf1f1;
bytes32 public elfCommitment =
0x35dd40ab04e180712996495caec915b8a7c488433acbb50c4d8d912cb55bf1f1;

// map to check if proof has already been submitted
mapping(bytes32 => bool) public mintedProofs;

constructor(address _alignedServiceManager) ERC721("Aligned Layer ZK Quiz", "AZKQ") {
constructor(
address _alignedServiceManager,
address _paymentServiceAddr
) ERC721("Aligned Layer ZK Quiz", "AZKQ") {
alignedServiceManager = _alignedServiceManager;
paymentServiceAddr = _paymentServiceAddr;
}

function verifyBatchInclusion(
Expand All@@ -27,25 +33,41 @@ contract VerifierContract is ERC721URIStorage {
bytes memory merkleProof,
uint256 verificationDataBatchIndex
) external returns (uint256) {
require(elfCommitment == provingSystemAuxDataCommitment, "ELF does not match");
require(address(proofGeneratorAddr) == msg.sender, "proofGeneratorAddr does not match");

bytes32 fullHash = keccak256(abi.encodePacked(proofCommitment,
pubInputCommitment, provingSystemAuxDataCommitment, proofGeneratorAddr));
require(!mintedProofs[fullHash], "proof already minted");
require(
elfCommitment == provingSystemAuxDataCommitment,
"ELF does not match"
);
require(
address(proofGeneratorAddr) == msg.sender,
"proofGeneratorAddr does not match"
);

(bool callWasSuccessfull, bytes memory proofIsIncluded) = alignedServiceManager.staticcall(
abi.encodeWithSignature(
"verifyBatchInclusion(bytes32,bytes32,bytes32,bytes20,bytes32,bytes,uint256)",
bytes32 fullHash = keccak256(
abi.encodePacked(
proofCommitment,
pubInputCommitment,
provingSystemAuxDataCommitment,
proofGeneratorAddr,
batchMerkleRoot,
merkleProof,
verificationDataBatchIndex
proofGeneratorAddr
)
);
require(!mintedProofs[fullHash], "proof already minted");

(
bool callWasSuccessfull,
bytes memory proofIsIncluded
) = alignedServiceManager.staticcall(
abi.encodeWithSignature(
"verifyBatchInclusion(bytes32,bytes32,bytes32,bytes20,bytes32,bytes,uint256,address)",
proofCommitment,
pubInputCommitment,
provingSystemAuxDataCommitment,
proofGeneratorAddr,
batchMerkleRoot,
merkleProof,
verificationDataBatchIndex,
paymentServiceAddr
)
);

require(callWasSuccessfull, "static_call failed");

Expand All@@ -56,15 +78,19 @@ contract VerifierContract is ERC721URIStorage {

uint256 tokenId = _nextTokenId++;
_mint(msg.sender, tokenId);
_setTokenURI(tokenId, "ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ");
_setTokenURI(
tokenId,
"ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ"
);

return tokenId;
}

function tokenURI(uint256 tokenId) public override view virtual returns (string memory) {
function tokenURI(
uint256 tokenId
) public view virtual override returns (string memory) {
_requireOwned(tokenId);

return "ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ";
}

}
4 changes: 3 additions & 1 deletion examples/zkquiz/quiz/program/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,4 +6,6 @@ edition = "2021"

[dependencies]
sp1-zkvm = { git = "https://github.com/succinctlabs/sp1.git", rev = "v1.0.8-testnet" }
tiny-keccak = { git = "https://github.com/sp1-patches/tiny-keccak", branch = "patch-v2.0.2", features = ["sha3"] }
tiny-keccak = { git = "https://github.com/sp1-patches/tiny-keccak", branch = "patch-v2.0.2", features = [
"sha3",
] }
52 changes: 51 additions & 1 deletion examples/zkquiz/quiz/script/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/zkquiz/quiz/script/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ edition = "2021"

[dependencies]
sp1-sdk = { git = "https://github.com/succinctlabs/sp1.git", rev = "v1.0.1" }
aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", tag = "v0.4.0" }
aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", rev = "6908110aaa04ec3107f15ab8a8bb2603e7bbead9" }
ethers = { tag = "v2.0.15-fix-reconnections", features = [
"ws",
"rustls",
Expand Down
2 changes: 1 addition & 1 deletion examples/zkquiz/quiz/script/VerifierContract.json

Large diffs are not rendered by default.

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
66 changes: 26 additions & 40 deletions docs/guides/2_integrating_aligned_into_your_application.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -116,12 +116,13 @@ The proof submission and verification can be done either with the SDK or by usin

#### Using the SDK

To submit a proof using the SDK, you can use the `submit` function, and then you can use the `verify_proof_onchain` function to check if the proof was correctly verified in Aligned.

To submit a proof using the SDK, you can use the `submit_and_wait_verification` function.
This function submits the proof to aligned and waits for it to be verified in Aligned.
Alternatively you can call `submit` if you dont want to wait for proof verification.
The following code is an example of how to submit a proof using the SDK:

```rust
use aligned_sdk::sdk::{submit, get_next_nonce};
use aligned_sdk::sdk::{submit_and_wait_verification, get_next_nonce};
use aligned_sdk::types::{ProvingSystemId, VerificationData};
use ethers::prelude::*;

Expand All@@ -147,13 +148,33 @@ async fn submit_proof_to_aligned(
.await
.map_err(|e| anyhow::anyhow!("Failed to get next nonce: {:?}", e))?;

submit(BATCHER_URL, &verification_data, wallet, nonce).await
.map_err(|e| anyhow::anyhow!("Failed to submit proof: {:?}", e))
match submit_and_wait_verification(
BATCHER_URL,
&rpc_url,
Chain::Holesky,
&verification_data,
wallet.clone(),
nonce,
BATCHER_PAYMENTS_ADDRESS
)

submit_and_wait_verification(
BATCHER_URL,
RPC_URL,
Chain::Holesky,
&verification_data,
wallet,
nonce,
BATCHER_CONTRACT_ADDRESS
).await.map_err(|e| anyhow::anyhow!("Failed to submit proof: {:?}", e))
}

#[tokio::main]
async fn main() {
let wallet = // Initialize wallet

let wallet = wallet.with_chain_id(17000u64)

let proof = // Generate or obtain proof

match submit_proof_to_aligned(proof, wallet).await {
Expand All@@ -163,41 +184,6 @@ async fn main() {
}
```

The following code is an example of how to verify the proof was correctly verified in Aligned using the SDK:

```rust
use aligned_sdk::sdk::verify_proof_onchain;
use aligned_sdk::types::{AlignedVerificationData, Chain};
use ethers::prelude::*;
use tokio::time::{sleep, Duration};

async fn wait_for_proof_verification(
aligned_verification_data: AlignedVerificationData,
rpc_url: String,
) -> Result<(), anyhow::Error> {
for _ in 0..10 {
if verify_proof_onchain(aligned_verification_data.clone(), Chain::Holesky, rpc_url.as_str()).await.is_ok_and(|r| r) {
println!("Proof verified successfully.");
return Ok(());
}
println!("Proof not verified yet. Waiting 10 seconds before checking again...");
sleep(Duration::from_secs(10)).await;
}
anyhow::bail!("Proof verification failed")
}

#[tokio::main]
async fn main() {
let aligned_verification_data = // Obtain aligned verification data
let rpc_url = "https://ethereum-holesky-rpc.publicnode.com".to_string();

match wait_for_proof_verification(aligned_verification_data, rpc_url).await {
Ok(_) => println!("Proof verified"),
Err(err) => println!("Error: {:?}", err),
}
}
```

You can find an example of the proof submission and verification in the [ZKQuiz Program](../../examples/zkquiz/quiz/script/src/main.rs).

This example generates a proof, instantiates a wallet to submit the proof, and then submits the proof to Aligned for verification. It then waits for the proof to be verified in Aligned.
Expand Down
2 changes: 1 addition & 1 deletion examples/zkquiz/Makefile
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
deploy_verifier:
@. ./contracts/.env && . ./contracts/deploy.sh

CONTRACT_ADDRESS=0x8dB9e6f1393c3486F30181d606312ec632189621
CONTRACT_ADDRESS=0xA828f1463074d26FB761c662F80194f5dB2d31D0
RPC_URL=https://ethereum-holesky-rpc.publicnode.com
VERIFICATION_DATA=./aligned_verification_data/0a1fab5df88a71e48633cbdeedc8d1a234b790d15a8a2fd04cd6a03c1e05b5ef_212.json

Expand Down
1 change: 1 addition & 0 deletions examples/zkquiz/contracts/.env.example
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
RPC_URL=<rpc_url>
PRIVATE_KEY=<private_key>
ALIGNED_SERVICE_MANAGER_ADDRESS=<aligned_service_manager_addr># 0x58F280BeBE9B34c9939C3C39e0890C81f163B623 for Holesky
BATCHER_PAYMENT_SERVICE_ADDRESS=<batcher_payment_service_addr># 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
ETHERSCAN_API_KEY=<etherscan_api_key>
9 changes: 7 additions & 2 deletions examples/zkquiz/contracts/deploy.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,11 @@ if [ -z "$ALIGNED_SERVICE_MANAGER_ADDRESS" ]; then
exit 1
fi

if [ -z "$BATCHER_PAYMENT_SERVICE_ADDRESS" ]; then
echo "BATCHER_PAYMENT_SERVICE_ADDRESS is not set. Please set it in .env"
exit 1
fi

if [ -z "$RPC_URL" ]; then
echo "RPC_URL is not set. Please set it in .env"
exit 1
Expand All@@ -24,8 +29,8 @@ fi
forge install

forge script script/Deployer.s.sol \
"$ALIGNED_SERVICE_MANAGER_ADDRESS" \
"$ALIGNED_SERVICE_MANAGER_ADDRESS" "$BATCHER_PAYMENT_SERVICE_ADDRESS" \
--rpc-url "$RPC_URL" \
--private-key "$PRIVATE_KEY" \
--broadcast \
--sig "run(address _alignedServiceManager)"
--sig "run(address _alignedServiceManager, address _paymentService)"
10 changes: 8 additions & 2 deletions examples/zkquiz/contracts/script/Deployer.s.sol
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,16 @@ import {VerifierContract} from "../src/VerifierContract.sol";
contract CounterScript is Script {
function setUp() public {}

function run(address _targetContract) external returns (address) {
function run(
address _alignedServiceManager,
address _paymentService
) external returns (address) {
vm.startBroadcast();

VerifierContract verifyBatchInclusionCaller = new VerifierContract(_targetContract);
VerifierContract verifyBatchInclusionCaller = new VerifierContract(
_alignedServiceManager,
_paymentService
);

vm.stopBroadcast();

Expand Down
62 changes: 44 additions & 18 deletions examples/zkquiz/contracts/src/VerifierContract.sol
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,14 +8,20 @@ contract VerifierContract is ERC721URIStorage {
uint256 private _nextTokenId;

address public alignedServiceManager;
address public paymentServiceAddr;

bytes32 public elfCommitment = 0x35dd40ab04e180712996495caec915b8a7c488433acbb50c4d8d912cb55bf1f1;
bytes32 public elfCommitment =
0x35dd40ab04e180712996495caec915b8a7c488433acbb50c4d8d912cb55bf1f1;

// map to check if proof has already been submitted
mapping(bytes32 => bool) public mintedProofs;

constructor(address _alignedServiceManager) ERC721("Aligned Layer ZK Quiz", "AZKQ") {
constructor(
address _alignedServiceManager,
address _paymentServiceAddr
) ERC721("Aligned Layer ZK Quiz", "AZKQ") {
alignedServiceManager = _alignedServiceManager;
paymentServiceAddr = _paymentServiceAddr;
}

function verifyBatchInclusion(
Expand All@@ -27,25 +33,41 @@ contract VerifierContract is ERC721URIStorage {
bytes memory merkleProof,
uint256 verificationDataBatchIndex
) external returns (uint256) {
require(elfCommitment == provingSystemAuxDataCommitment, "ELF does not match");
require(address(proofGeneratorAddr) == msg.sender, "proofGeneratorAddr does not match");

bytes32 fullHash = keccak256(abi.encodePacked(proofCommitment,
pubInputCommitment, provingSystemAuxDataCommitment, proofGeneratorAddr));
require(!mintedProofs[fullHash], "proof already minted");
require(
elfCommitment == provingSystemAuxDataCommitment,
"ELF does not match"
);
require(
address(proofGeneratorAddr) == msg.sender,
"proofGeneratorAddr does not match"
);

(bool callWasSuccessfull, bytes memory proofIsIncluded) = alignedServiceManager.staticcall(
abi.encodeWithSignature(
"verifyBatchInclusion(bytes32,bytes32,bytes32,bytes20,bytes32,bytes,uint256)",
bytes32 fullHash = keccak256(
abi.encodePacked(
proofCommitment,
pubInputCommitment,
provingSystemAuxDataCommitment,
proofGeneratorAddr,
batchMerkleRoot,
merkleProof,
verificationDataBatchIndex
proofGeneratorAddr
)
);
require(!mintedProofs[fullHash], "proof already minted");

(
bool callWasSuccessfull,
bytes memory proofIsIncluded
) = alignedServiceManager.staticcall(
abi.encodeWithSignature(
"verifyBatchInclusion(bytes32,bytes32,bytes32,bytes20,bytes32,bytes,uint256,address)",
proofCommitment,
pubInputCommitment,
provingSystemAuxDataCommitment,
proofGeneratorAddr,
batchMerkleRoot,
merkleProof,
verificationDataBatchIndex,
paymentServiceAddr
)
);

require(callWasSuccessfull, "static_call failed");

Expand All@@ -56,15 +78,19 @@ contract VerifierContract is ERC721URIStorage {

uint256 tokenId = _nextTokenId++;
_mint(msg.sender, tokenId);
_setTokenURI(tokenId, "ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ");
_setTokenURI(
tokenId,
"ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ"
);

return tokenId;
}

function tokenURI(uint256 tokenId) public override view virtual returns (string memory) {
function tokenURI(
uint256 tokenId
) public view virtual override returns (string memory) {
_requireOwned(tokenId);

return "ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ";
}

}
4 changes: 3 additions & 1 deletion examples/zkquiz/quiz/program/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,4 +6,6 @@ edition = "2021"

[dependencies]
sp1-zkvm = { git = "https://github.com/succinctlabs/sp1.git", rev = "v1.0.8-testnet" }
tiny-keccak = { git = "https://github.com/sp1-patches/tiny-keccak", branch = "patch-v2.0.2", features = ["sha3"] }
tiny-keccak = { git = "https://github.com/sp1-patches/tiny-keccak", branch = "patch-v2.0.2", features = [
"sha3",
] }
52 changes: 51 additions & 1 deletion examples/zkquiz/quiz/script/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/zkquiz/quiz/script/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ edition = "2021"

[dependencies]
sp1-sdk = { git = "https://github.com/succinctlabs/sp1.git", rev = "v1.0.1" }
aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", tag = "v0.4.0" }
aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", rev = "6908110aaa04ec3107f15ab8a8bb2603e7bbead9" }
ethers = { tag = "v2.0.15-fix-reconnections", features = [
"ws",
"rustls",
Expand Down
2 changes: 1 addition & 1 deletion examples/zkquiz/quiz/script/VerifierContract.json

Large diffs are not rendered by default.

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
66 changes: 26 additions & 40 deletions docs/guides/2_integrating_aligned_into_your_application.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -116,12 +116,13 @@ The proof submission and verification can be done either with the SDK or by usin

#### Using the SDK

To submit a proof using the SDK, you can use the `submit` function, and then you can use the `verify_proof_onchain` function to check if the proof was correctly verified in Aligned.

To submit a proof using the SDK, you can use the `submit_and_wait_verification` function.
This function submits the proof to aligned and waits for it to be verified in Aligned.
Alternatively you can call `submit` if you dont want to wait for proof verification.
The following code is an example of how to submit a proof using the SDK:

```rust
use aligned_sdk::sdk::{submit, get_next_nonce};
use aligned_sdk::sdk::{submit_and_wait_verification, get_next_nonce};
use aligned_sdk::types::{ProvingSystemId, VerificationData};
use ethers::prelude::*;

Expand All@@ -147,13 +148,33 @@ async fn submit_proof_to_aligned(
.await
.map_err(|e| anyhow::anyhow!("Failed to get next nonce: {:?}", e))?;

submit(BATCHER_URL, &verification_data, wallet, nonce).await
.map_err(|e| anyhow::anyhow!("Failed to submit proof: {:?}", e))
match submit_and_wait_verification(
BATCHER_URL,
&rpc_url,
Chain::Holesky,
&verification_data,
wallet.clone(),
nonce,
BATCHER_PAYMENTS_ADDRESS
)

submit_and_wait_verification(
BATCHER_URL,
RPC_URL,
Chain::Holesky,
&verification_data,
wallet,
nonce,
BATCHER_CONTRACT_ADDRESS
).await.map_err(|e| anyhow::anyhow!("Failed to submit proof: {:?}", e))
}

#[tokio::main]
async fn main() {
let wallet = // Initialize wallet

let wallet = wallet.with_chain_id(17000u64)

let proof = // Generate or obtain proof

match submit_proof_to_aligned(proof, wallet).await {
Expand All@@ -163,41 +184,6 @@ async fn main() {
}
```

The following code is an example of how to verify the proof was correctly verified in Aligned using the SDK:

```rust
use aligned_sdk::sdk::verify_proof_onchain;
use aligned_sdk::types::{AlignedVerificationData, Chain};
use ethers::prelude::*;
use tokio::time::{sleep, Duration};

async fn wait_for_proof_verification(
aligned_verification_data: AlignedVerificationData,
rpc_url: String,
) -> Result<(), anyhow::Error> {
for _ in 0..10 {
if verify_proof_onchain(aligned_verification_data.clone(), Chain::Holesky, rpc_url.as_str()).await.is_ok_and(|r| r) {
println!("Proof verified successfully.");
return Ok(());
}
println!("Proof not verified yet. Waiting 10 seconds before checking again...");
sleep(Duration::from_secs(10)).await;
}
anyhow::bail!("Proof verification failed")
}

#[tokio::main]
async fn main() {
let aligned_verification_data = // Obtain aligned verification data
let rpc_url = "https://ethereum-holesky-rpc.publicnode.com".to_string();

match wait_for_proof_verification(aligned_verification_data, rpc_url).await {
Ok(_) => println!("Proof verified"),
Err(err) => println!("Error: {:?}", err),
}
}
```

You can find an example of the proof submission and verification in the [ZKQuiz Program](../../examples/zkquiz/quiz/script/src/main.rs).

This example generates a proof, instantiates a wallet to submit the proof, and then submits the proof to Aligned for verification. It then waits for the proof to be verified in Aligned.
Expand Down
2 changes: 1 addition & 1 deletion examples/zkquiz/Makefile
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
deploy_verifier:
@. ./contracts/.env && . ./contracts/deploy.sh

CONTRACT_ADDRESS=0x8dB9e6f1393c3486F30181d606312ec632189621
CONTRACT_ADDRESS=0xA828f1463074d26FB761c662F80194f5dB2d31D0
RPC_URL=https://ethereum-holesky-rpc.publicnode.com
VERIFICATION_DATA=./aligned_verification_data/0a1fab5df88a71e48633cbdeedc8d1a234b790d15a8a2fd04cd6a03c1e05b5ef_212.json

Expand Down
1 change: 1 addition & 0 deletions examples/zkquiz/contracts/.env.example
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
RPC_URL=<rpc_url>
PRIVATE_KEY=<private_key>
ALIGNED_SERVICE_MANAGER_ADDRESS=<aligned_service_manager_addr># 0x58F280BeBE9B34c9939C3C39e0890C81f163B623 for Holesky
BATCHER_PAYMENT_SERVICE_ADDRESS=<batcher_payment_service_addr># 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
ETHERSCAN_API_KEY=<etherscan_api_key>
9 changes: 7 additions & 2 deletions examples/zkquiz/contracts/deploy.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,11 @@ if [ -z "$ALIGNED_SERVICE_MANAGER_ADDRESS" ]; then
exit 1
fi

if [ -z "$BATCHER_PAYMENT_SERVICE_ADDRESS" ]; then
echo "BATCHER_PAYMENT_SERVICE_ADDRESS is not set. Please set it in .env"
exit 1
fi

if [ -z "$RPC_URL" ]; then
echo "RPC_URL is not set. Please set it in .env"
exit 1
Expand All@@ -24,8 +29,8 @@ fi
forge install

forge script script/Deployer.s.sol \
"$ALIGNED_SERVICE_MANAGER_ADDRESS" \
"$ALIGNED_SERVICE_MANAGER_ADDRESS" "$BATCHER_PAYMENT_SERVICE_ADDRESS" \
--rpc-url "$RPC_URL" \
--private-key "$PRIVATE_KEY" \
--broadcast \
--sig "run(address _alignedServiceManager)"
--sig "run(address _alignedServiceManager, address _paymentService)"
10 changes: 8 additions & 2 deletions examples/zkquiz/contracts/script/Deployer.s.sol
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,16 @@ import {VerifierContract} from "../src/VerifierContract.sol";
contract CounterScript is Script {
function setUp() public {}

function run(address _targetContract) external returns (address) {
function run(
address _alignedServiceManager,
address _paymentService
) external returns (address) {
vm.startBroadcast();

VerifierContract verifyBatchInclusionCaller = new VerifierContract(_targetContract);
VerifierContract verifyBatchInclusionCaller = new VerifierContract(
_alignedServiceManager,
_paymentService
);

vm.stopBroadcast();

Expand Down
62 changes: 44 additions & 18 deletions examples/zkquiz/contracts/src/VerifierContract.sol
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,14 +8,20 @@ contract VerifierContract is ERC721URIStorage {
uint256 private _nextTokenId;

address public alignedServiceManager;
address public paymentServiceAddr;

bytes32 public elfCommitment = 0x35dd40ab04e180712996495caec915b8a7c488433acbb50c4d8d912cb55bf1f1;
bytes32 public elfCommitment =
0x35dd40ab04e180712996495caec915b8a7c488433acbb50c4d8d912cb55bf1f1;

// map to check if proof has already been submitted
mapping(bytes32 => bool) public mintedProofs;

constructor(address _alignedServiceManager) ERC721("Aligned Layer ZK Quiz", "AZKQ") {
constructor(
address _alignedServiceManager,
address _paymentServiceAddr
) ERC721("Aligned Layer ZK Quiz", "AZKQ") {
alignedServiceManager = _alignedServiceManager;
paymentServiceAddr = _paymentServiceAddr;
}

function verifyBatchInclusion(
Expand All@@ -27,25 +33,41 @@ contract VerifierContract is ERC721URIStorage {
bytes memory merkleProof,
uint256 verificationDataBatchIndex
) external returns (uint256) {
require(elfCommitment == provingSystemAuxDataCommitment, "ELF does not match");
require(address(proofGeneratorAddr) == msg.sender, "proofGeneratorAddr does not match");

bytes32 fullHash = keccak256(abi.encodePacked(proofCommitment,
pubInputCommitment, provingSystemAuxDataCommitment, proofGeneratorAddr));
require(!mintedProofs[fullHash], "proof already minted");
require(
elfCommitment == provingSystemAuxDataCommitment,
"ELF does not match"
);
require(
address(proofGeneratorAddr) == msg.sender,
"proofGeneratorAddr does not match"
);

(bool callWasSuccessfull, bytes memory proofIsIncluded) = alignedServiceManager.staticcall(
abi.encodeWithSignature(
"verifyBatchInclusion(bytes32,bytes32,bytes32,bytes20,bytes32,bytes,uint256)",
bytes32 fullHash = keccak256(
abi.encodePacked(
proofCommitment,
pubInputCommitment,
provingSystemAuxDataCommitment,
proofGeneratorAddr,
batchMerkleRoot,
merkleProof,
verificationDataBatchIndex
proofGeneratorAddr
)
);
require(!mintedProofs[fullHash], "proof already minted");

(
bool callWasSuccessfull,
bytes memory proofIsIncluded
) = alignedServiceManager.staticcall(
abi.encodeWithSignature(
"verifyBatchInclusion(bytes32,bytes32,bytes32,bytes20,bytes32,bytes,uint256,address)",
proofCommitment,
pubInputCommitment,
provingSystemAuxDataCommitment,
proofGeneratorAddr,
batchMerkleRoot,
merkleProof,
verificationDataBatchIndex,
paymentServiceAddr
)
);

require(callWasSuccessfull, "static_call failed");

Expand All@@ -56,15 +78,19 @@ contract VerifierContract is ERC721URIStorage {

uint256 tokenId = _nextTokenId++;
_mint(msg.sender, tokenId);
_setTokenURI(tokenId, "ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ");
_setTokenURI(
tokenId,
"ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ"
);

return tokenId;
}

function tokenURI(uint256 tokenId) public override view virtual returns (string memory) {
function tokenURI(
uint256 tokenId
) public view virtual override returns (string memory) {
_requireOwned(tokenId);

return "ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ";
}

}
4 changes: 3 additions & 1 deletion examples/zkquiz/quiz/program/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,4 +6,6 @@ edition = "2021"

[dependencies]
sp1-zkvm = { git = "https://github.com/succinctlabs/sp1.git", rev = "v1.0.8-testnet" }
tiny-keccak = { git = "https://github.com/sp1-patches/tiny-keccak", branch = "patch-v2.0.2", features = ["sha3"] }
tiny-keccak = { git = "https://github.com/sp1-patches/tiny-keccak", branch = "patch-v2.0.2", features = [
"sha3",
] }
52 changes: 51 additions & 1 deletion examples/zkquiz/quiz/script/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/zkquiz/quiz/script/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ edition = "2021"

[dependencies]
sp1-sdk = { git = "https://github.com/succinctlabs/sp1.git", rev = "v1.0.1" }
aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", tag = "v0.4.0" }
aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", rev = "6908110aaa04ec3107f15ab8a8bb2603e7bbead9" }
ethers = { tag = "v2.0.15-fix-reconnections", features = [
"ws",
"rustls",
Expand Down
2 changes: 1 addition & 1 deletion examples/zkquiz/quiz/script/VerifierContract.json

Large diffs are not rendered by default.

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
66 changes: 26 additions & 40 deletions docs/guides/2_integrating_aligned_into_your_application.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -116,12 +116,13 @@ The proof submission and verification can be done either with the SDK or by usin

#### Using the SDK

To submit a proof using the SDK, you can use the `submit` function, and then you can use the `verify_proof_onchain` function to check if the proof was correctly verified in Aligned.

To submit a proof using the SDK, you can use the `submit_and_wait_verification` function.
This function submits the proof to aligned and waits for it to be verified in Aligned.
Alternatively you can call `submit` if you dont want to wait for proof verification.
The following code is an example of how to submit a proof using the SDK:

```rust
use aligned_sdk::sdk::{submit, get_next_nonce};
use aligned_sdk::sdk::{submit_and_wait_verification, get_next_nonce};
use aligned_sdk::types::{ProvingSystemId, VerificationData};
use ethers::prelude::*;

Expand All@@ -147,13 +148,33 @@ async fn submit_proof_to_aligned(
.await
.map_err(|e| anyhow::anyhow!("Failed to get next nonce: {:?}", e))?;

submit(BATCHER_URL, &verification_data, wallet, nonce).await
.map_err(|e| anyhow::anyhow!("Failed to submit proof: {:?}", e))
match submit_and_wait_verification(
BATCHER_URL,
&rpc_url,
Chain::Holesky,
&verification_data,
wallet.clone(),
nonce,
BATCHER_PAYMENTS_ADDRESS
)

submit_and_wait_verification(
BATCHER_URL,
RPC_URL,
Chain::Holesky,
&verification_data,
wallet,
nonce,
BATCHER_CONTRACT_ADDRESS
).await.map_err(|e| anyhow::anyhow!("Failed to submit proof: {:?}", e))
}

#[tokio::main]
async fn main() {
let wallet = // Initialize wallet

let wallet = wallet.with_chain_id(17000u64)

let proof = // Generate or obtain proof

match submit_proof_to_aligned(proof, wallet).await {
Expand All@@ -163,41 +184,6 @@ async fn main() {
}
```

The following code is an example of how to verify the proof was correctly verified in Aligned using the SDK:

```rust
use aligned_sdk::sdk::verify_proof_onchain;
use aligned_sdk::types::{AlignedVerificationData, Chain};
use ethers::prelude::*;
use tokio::time::{sleep, Duration};

async fn wait_for_proof_verification(
aligned_verification_data: AlignedVerificationData,
rpc_url: String,
) -> Result<(), anyhow::Error> {
for _ in 0..10 {
if verify_proof_onchain(aligned_verification_data.clone(), Chain::Holesky, rpc_url.as_str()).await.is_ok_and(|r| r) {
println!("Proof verified successfully.");
return Ok(());
}
println!("Proof not verified yet. Waiting 10 seconds before checking again...");
sleep(Duration::from_secs(10)).await;
}
anyhow::bail!("Proof verification failed")
}

#[tokio::main]
async fn main() {
let aligned_verification_data = // Obtain aligned verification data
let rpc_url = "https://ethereum-holesky-rpc.publicnode.com".to_string();

match wait_for_proof_verification(aligned_verification_data, rpc_url).await {
Ok(_) => println!("Proof verified"),
Err(err) => println!("Error: {:?}", err),
}
}
```

You can find an example of the proof submission and verification in the [ZKQuiz Program](../../examples/zkquiz/quiz/script/src/main.rs).

This example generates a proof, instantiates a wallet to submit the proof, and then submits the proof to Aligned for verification. It then waits for the proof to be verified in Aligned.
Expand Down
2 changes: 1 addition & 1 deletion examples/zkquiz/Makefile
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
deploy_verifier:
@. ./contracts/.env && . ./contracts/deploy.sh

CONTRACT_ADDRESS=0x8dB9e6f1393c3486F30181d606312ec632189621
CONTRACT_ADDRESS=0xA828f1463074d26FB761c662F80194f5dB2d31D0
RPC_URL=https://ethereum-holesky-rpc.publicnode.com
VERIFICATION_DATA=./aligned_verification_data/0a1fab5df88a71e48633cbdeedc8d1a234b790d15a8a2fd04cd6a03c1e05b5ef_212.json

Expand Down
1 change: 1 addition & 0 deletions examples/zkquiz/contracts/.env.example
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
RPC_URL=<rpc_url>
PRIVATE_KEY=<private_key>
ALIGNED_SERVICE_MANAGER_ADDRESS=<aligned_service_manager_addr># 0x58F280BeBE9B34c9939C3C39e0890C81f163B623 for Holesky
BATCHER_PAYMENT_SERVICE_ADDRESS=<batcher_payment_service_addr># 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
ETHERSCAN_API_KEY=<etherscan_api_key>
9 changes: 7 additions & 2 deletions examples/zkquiz/contracts/deploy.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,11 @@ if [ -z "$ALIGNED_SERVICE_MANAGER_ADDRESS" ]; then
exit 1
fi

if [ -z "$BATCHER_PAYMENT_SERVICE_ADDRESS" ]; then
echo "BATCHER_PAYMENT_SERVICE_ADDRESS is not set. Please set it in .env"
exit 1
fi

if [ -z "$RPC_URL" ]; then
echo "RPC_URL is not set. Please set it in .env"
exit 1
Expand All@@ -24,8 +29,8 @@ fi
forge install

forge script script/Deployer.s.sol \
"$ALIGNED_SERVICE_MANAGER_ADDRESS" \
"$ALIGNED_SERVICE_MANAGER_ADDRESS" "$BATCHER_PAYMENT_SERVICE_ADDRESS" \
--rpc-url "$RPC_URL" \
--private-key "$PRIVATE_KEY" \
--broadcast \
--sig "run(address _alignedServiceManager)"
--sig "run(address _alignedServiceManager, address _paymentService)"
10 changes: 8 additions & 2 deletions examples/zkquiz/contracts/script/Deployer.s.sol
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,16 @@ import {VerifierContract} from "../src/VerifierContract.sol";
contract CounterScript is Script {
function setUp() public {}

function run(address _targetContract) external returns (address) {
function run(
address _alignedServiceManager,
address _paymentService
) external returns (address) {
vm.startBroadcast();

VerifierContract verifyBatchInclusionCaller = new VerifierContract(_targetContract);
VerifierContract verifyBatchInclusionCaller = new VerifierContract(
_alignedServiceManager,
_paymentService
);

vm.stopBroadcast();

Expand Down
62 changes: 44 additions & 18 deletions examples/zkquiz/contracts/src/VerifierContract.sol
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,14 +8,20 @@ contract VerifierContract is ERC721URIStorage {
uint256 private _nextTokenId;

address public alignedServiceManager;
address public paymentServiceAddr;

bytes32 public elfCommitment = 0x35dd40ab04e180712996495caec915b8a7c488433acbb50c4d8d912cb55bf1f1;
bytes32 public elfCommitment =
0x35dd40ab04e180712996495caec915b8a7c488433acbb50c4d8d912cb55bf1f1;

// map to check if proof has already been submitted
mapping(bytes32 => bool) public mintedProofs;

constructor(address _alignedServiceManager) ERC721("Aligned Layer ZK Quiz", "AZKQ") {
constructor(
address _alignedServiceManager,
address _paymentServiceAddr
) ERC721("Aligned Layer ZK Quiz", "AZKQ") {
alignedServiceManager = _alignedServiceManager;
paymentServiceAddr = _paymentServiceAddr;
}

function verifyBatchInclusion(
Expand All@@ -27,25 +33,41 @@ contract VerifierContract is ERC721URIStorage {
bytes memory merkleProof,
uint256 verificationDataBatchIndex
) external returns (uint256) {
require(elfCommitment == provingSystemAuxDataCommitment, "ELF does not match");
require(address(proofGeneratorAddr) == msg.sender, "proofGeneratorAddr does not match");

bytes32 fullHash = keccak256(abi.encodePacked(proofCommitment,
pubInputCommitment, provingSystemAuxDataCommitment, proofGeneratorAddr));
require(!mintedProofs[fullHash], "proof already minted");
require(
elfCommitment == provingSystemAuxDataCommitment,
"ELF does not match"
);
require(
address(proofGeneratorAddr) == msg.sender,
"proofGeneratorAddr does not match"
);

(bool callWasSuccessfull, bytes memory proofIsIncluded) = alignedServiceManager.staticcall(
abi.encodeWithSignature(
"verifyBatchInclusion(bytes32,bytes32,bytes32,bytes20,bytes32,bytes,uint256)",
bytes32 fullHash = keccak256(
abi.encodePacked(
proofCommitment,
pubInputCommitment,
provingSystemAuxDataCommitment,
proofGeneratorAddr,
batchMerkleRoot,
merkleProof,
verificationDataBatchIndex
proofGeneratorAddr
)
);
require(!mintedProofs[fullHash], "proof already minted");

(
bool callWasSuccessfull,
bytes memory proofIsIncluded
) = alignedServiceManager.staticcall(
abi.encodeWithSignature(
"verifyBatchInclusion(bytes32,bytes32,bytes32,bytes20,bytes32,bytes,uint256,address)",
proofCommitment,
pubInputCommitment,
provingSystemAuxDataCommitment,
proofGeneratorAddr,
batchMerkleRoot,
merkleProof,
verificationDataBatchIndex,
paymentServiceAddr
)
);

require(callWasSuccessfull, "static_call failed");

Expand All@@ -56,15 +78,19 @@ contract VerifierContract is ERC721URIStorage {

uint256 tokenId = _nextTokenId++;
_mint(msg.sender, tokenId);
_setTokenURI(tokenId, "ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ");
_setTokenURI(
tokenId,
"ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ"
);

return tokenId;
}

function tokenURI(uint256 tokenId) public override view virtual returns (string memory) {
function tokenURI(
uint256 tokenId
) public view virtual override returns (string memory) {
_requireOwned(tokenId);

return "ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ";
}

}
4 changes: 3 additions & 1 deletion examples/zkquiz/quiz/program/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,4 +6,6 @@ edition = "2021"

[dependencies]
sp1-zkvm = { git = "https://github.com/succinctlabs/sp1.git", rev = "v1.0.8-testnet" }
tiny-keccak = { git = "https://github.com/sp1-patches/tiny-keccak", branch = "patch-v2.0.2", features = ["sha3"] }
tiny-keccak = { git = "https://github.com/sp1-patches/tiny-keccak", branch = "patch-v2.0.2", features = [
"sha3",
] }
52 changes: 51 additions & 1 deletion examples/zkquiz/quiz/script/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/zkquiz/quiz/script/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ edition = "2021"

[dependencies]
sp1-sdk = { git = "https://github.com/succinctlabs/sp1.git", rev = "v1.0.1" }
aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", tag = "v0.4.0" }
aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", rev = "6908110aaa04ec3107f15ab8a8bb2603e7bbead9" }
ethers = { tag = "v2.0.15-fix-reconnections", features = [
"ws",
"rustls",
Expand Down
2 changes: 1 addition & 1 deletion examples/zkquiz/quiz/script/VerifierContract.json

Large diffs are not rendered by default.

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
66 changes: 26 additions & 40 deletions docs/guides/2_integrating_aligned_into_your_application.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -116,12 +116,13 @@ The proof submission and verification can be done either with the SDK or by usin

#### Using the SDK

To submit a proof using the SDK, you can use the `submit` function, and then you can use the `verify_proof_onchain` function to check if the proof was correctly verified in Aligned.

To submit a proof using the SDK, you can use the `submit_and_wait_verification` function.
This function submits the proof to aligned and waits for it to be verified in Aligned.
Alternatively you can call `submit` if you dont want to wait for proof verification.
The following code is an example of how to submit a proof using the SDK:

```rust
use aligned_sdk::sdk::{submit, get_next_nonce};
use aligned_sdk::sdk::{submit_and_wait_verification, get_next_nonce};
use aligned_sdk::types::{ProvingSystemId, VerificationData};
use ethers::prelude::*;

Expand All@@ -147,13 +148,33 @@ async fn submit_proof_to_aligned(
.await
.map_err(|e| anyhow::anyhow!("Failed to get next nonce: {:?}", e))?;

submit(BATCHER_URL, &verification_data, wallet, nonce).await
.map_err(|e| anyhow::anyhow!("Failed to submit proof: {:?}", e))
match submit_and_wait_verification(
BATCHER_URL,
&rpc_url,
Chain::Holesky,
&verification_data,
wallet.clone(),
nonce,
BATCHER_PAYMENTS_ADDRESS
)

submit_and_wait_verification(
BATCHER_URL,
RPC_URL,
Chain::Holesky,
&verification_data,
wallet,
nonce,
BATCHER_CONTRACT_ADDRESS
).await.map_err(|e| anyhow::anyhow!("Failed to submit proof: {:?}", e))
}

#[tokio::main]
async fn main() {
let wallet = // Initialize wallet

let wallet = wallet.with_chain_id(17000u64)

let proof = // Generate or obtain proof

match submit_proof_to_aligned(proof, wallet).await {
Expand All@@ -163,41 +184,6 @@ async fn main() {
}
```

The following code is an example of how to verify the proof was correctly verified in Aligned using the SDK:

```rust
use aligned_sdk::sdk::verify_proof_onchain;
use aligned_sdk::types::{AlignedVerificationData, Chain};
use ethers::prelude::*;
use tokio::time::{sleep, Duration};

async fn wait_for_proof_verification(
aligned_verification_data: AlignedVerificationData,
rpc_url: String,
) -> Result<(), anyhow::Error> {
for _ in 0..10 {
if verify_proof_onchain(aligned_verification_data.clone(), Chain::Holesky, rpc_url.as_str()).await.is_ok_and(|r| r) {
println!("Proof verified successfully.");
return Ok(());
}
println!("Proof not verified yet. Waiting 10 seconds before checking again...");
sleep(Duration::from_secs(10)).await;
}
anyhow::bail!("Proof verification failed")
}

#[tokio::main]
async fn main() {
let aligned_verification_data = // Obtain aligned verification data
let rpc_url = "https://ethereum-holesky-rpc.publicnode.com".to_string();

match wait_for_proof_verification(aligned_verification_data, rpc_url).await {
Ok(_) => println!("Proof verified"),
Err(err) => println!("Error: {:?}", err),
}
}
```

You can find an example of the proof submission and verification in the [ZKQuiz Program](../../examples/zkquiz/quiz/script/src/main.rs).

This example generates a proof, instantiates a wallet to submit the proof, and then submits the proof to Aligned for verification. It then waits for the proof to be verified in Aligned.
Expand Down
2 changes: 1 addition & 1 deletion examples/zkquiz/Makefile
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
deploy_verifier:
@. ./contracts/.env && . ./contracts/deploy.sh

CONTRACT_ADDRESS=0x8dB9e6f1393c3486F30181d606312ec632189621
CONTRACT_ADDRESS=0xA828f1463074d26FB761c662F80194f5dB2d31D0
RPC_URL=https://ethereum-holesky-rpc.publicnode.com
VERIFICATION_DATA=./aligned_verification_data/0a1fab5df88a71e48633cbdeedc8d1a234b790d15a8a2fd04cd6a03c1e05b5ef_212.json

Expand Down
1 change: 1 addition & 0 deletions examples/zkquiz/contracts/.env.example
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
RPC_URL=<rpc_url>
PRIVATE_KEY=<private_key>
ALIGNED_SERVICE_MANAGER_ADDRESS=<aligned_service_manager_addr># 0x58F280BeBE9B34c9939C3C39e0890C81f163B623 for Holesky
BATCHER_PAYMENT_SERVICE_ADDRESS=<batcher_payment_service_addr># 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
ETHERSCAN_API_KEY=<etherscan_api_key>
9 changes: 7 additions & 2 deletions examples/zkquiz/contracts/deploy.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,11 @@ if [ -z "$ALIGNED_SERVICE_MANAGER_ADDRESS" ]; then
exit 1
fi

if [ -z "$BATCHER_PAYMENT_SERVICE_ADDRESS" ]; then
echo "BATCHER_PAYMENT_SERVICE_ADDRESS is not set. Please set it in .env"
exit 1
fi

if [ -z "$RPC_URL" ]; then
echo "RPC_URL is not set. Please set it in .env"
exit 1
Expand All@@ -24,8 +29,8 @@ fi
forge install

forge script script/Deployer.s.sol \
"$ALIGNED_SERVICE_MANAGER_ADDRESS" \
"$ALIGNED_SERVICE_MANAGER_ADDRESS" "$BATCHER_PAYMENT_SERVICE_ADDRESS" \
--rpc-url "$RPC_URL" \
--private-key "$PRIVATE_KEY" \
--broadcast \
--sig "run(address _alignedServiceManager)"
--sig "run(address _alignedServiceManager, address _paymentService)"
10 changes: 8 additions & 2 deletions examples/zkquiz/contracts/script/Deployer.s.sol
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,16 @@ import {VerifierContract} from "../src/VerifierContract.sol";
contract CounterScript is Script {
function setUp() public {}

function run(address _targetContract) external returns (address) {
function run(
address _alignedServiceManager,
address _paymentService
) external returns (address) {
vm.startBroadcast();

VerifierContract verifyBatchInclusionCaller = new VerifierContract(_targetContract);
VerifierContract verifyBatchInclusionCaller = new VerifierContract(
_alignedServiceManager,
_paymentService
);

vm.stopBroadcast();

Expand Down
62 changes: 44 additions & 18 deletions examples/zkquiz/contracts/src/VerifierContract.sol
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,14 +8,20 @@ contract VerifierContract is ERC721URIStorage {
uint256 private _nextTokenId;

address public alignedServiceManager;
address public paymentServiceAddr;

bytes32 public elfCommitment = 0x35dd40ab04e180712996495caec915b8a7c488433acbb50c4d8d912cb55bf1f1;
bytes32 public elfCommitment =
0x35dd40ab04e180712996495caec915b8a7c488433acbb50c4d8d912cb55bf1f1;

// map to check if proof has already been submitted
mapping(bytes32 => bool) public mintedProofs;

constructor(address _alignedServiceManager) ERC721("Aligned Layer ZK Quiz", "AZKQ") {
constructor(
address _alignedServiceManager,
address _paymentServiceAddr
) ERC721("Aligned Layer ZK Quiz", "AZKQ") {
alignedServiceManager = _alignedServiceManager;
paymentServiceAddr = _paymentServiceAddr;
}

function verifyBatchInclusion(
Expand All@@ -27,25 +33,41 @@ contract VerifierContract is ERC721URIStorage {
bytes memory merkleProof,
uint256 verificationDataBatchIndex
) external returns (uint256) {
require(elfCommitment == provingSystemAuxDataCommitment, "ELF does not match");
require(address(proofGeneratorAddr) == msg.sender, "proofGeneratorAddr does not match");

bytes32 fullHash = keccak256(abi.encodePacked(proofCommitment,
pubInputCommitment, provingSystemAuxDataCommitment, proofGeneratorAddr));
require(!mintedProofs[fullHash], "proof already minted");
require(
elfCommitment == provingSystemAuxDataCommitment,
"ELF does not match"
);
require(
address(proofGeneratorAddr) == msg.sender,
"proofGeneratorAddr does not match"
);

(bool callWasSuccessfull, bytes memory proofIsIncluded) = alignedServiceManager.staticcall(
abi.encodeWithSignature(
"verifyBatchInclusion(bytes32,bytes32,bytes32,bytes20,bytes32,bytes,uint256)",
bytes32 fullHash = keccak256(
abi.encodePacked(
proofCommitment,
pubInputCommitment,
provingSystemAuxDataCommitment,
proofGeneratorAddr,
batchMerkleRoot,
merkleProof,
verificationDataBatchIndex
proofGeneratorAddr
)
);
require(!mintedProofs[fullHash], "proof already minted");

(
bool callWasSuccessfull,
bytes memory proofIsIncluded
) = alignedServiceManager.staticcall(
abi.encodeWithSignature(
"verifyBatchInclusion(bytes32,bytes32,bytes32,bytes20,bytes32,bytes,uint256,address)",
proofCommitment,
pubInputCommitment,
provingSystemAuxDataCommitment,
proofGeneratorAddr,
batchMerkleRoot,
merkleProof,
verificationDataBatchIndex,
paymentServiceAddr
)
);

require(callWasSuccessfull, "static_call failed");

Expand All@@ -56,15 +78,19 @@ contract VerifierContract is ERC721URIStorage {

uint256 tokenId = _nextTokenId++;
_mint(msg.sender, tokenId);
_setTokenURI(tokenId, "ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ");
_setTokenURI(
tokenId,
"ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ"
);

return tokenId;
}

function tokenURI(uint256 tokenId) public override view virtual returns (string memory) {
function tokenURI(
uint256 tokenId
) public view virtual override returns (string memory) {
_requireOwned(tokenId);

return "ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ";
}

}
4 changes: 3 additions & 1 deletion examples/zkquiz/quiz/program/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,4 +6,6 @@ edition = "2021"

[dependencies]
sp1-zkvm = { git = "https://github.com/succinctlabs/sp1.git", rev = "v1.0.8-testnet" }
tiny-keccak = { git = "https://github.com/sp1-patches/tiny-keccak", branch = "patch-v2.0.2", features = ["sha3"] }
tiny-keccak = { git = "https://github.com/sp1-patches/tiny-keccak", branch = "patch-v2.0.2", features = [
"sha3",
] }
52 changes: 51 additions & 1 deletion examples/zkquiz/quiz/script/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/zkquiz/quiz/script/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ edition = "2021"

[dependencies]
sp1-sdk = { git = "https://github.com/succinctlabs/sp1.git", rev = "v1.0.1" }
aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", tag = "v0.4.0" }
aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", rev = "6908110aaa04ec3107f15ab8a8bb2603e7bbead9" }
ethers = { tag = "v2.0.15-fix-reconnections", features = [
"ws",
"rustls",
Expand Down
2 changes: 1 addition & 1 deletion examples/zkquiz/quiz/script/VerifierContract.json

Large diffs are not rendered by default.

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
66 changes: 26 additions & 40 deletions docs/guides/2_integrating_aligned_into_your_application.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -116,12 +116,13 @@ The proof submission and verification can be done either with the SDK or by usin

#### Using the SDK

To submit a proof using the SDK, you can use the `submit` function, and then you can use the `verify_proof_onchain` function to check if the proof was correctly verified in Aligned.

To submit a proof using the SDK, you can use the `submit_and_wait_verification` function.
This function submits the proof to aligned and waits for it to be verified in Aligned.
Alternatively you can call `submit` if you dont want to wait for proof verification.
The following code is an example of how to submit a proof using the SDK:

```rust
use aligned_sdk::sdk::{submit, get_next_nonce};
use aligned_sdk::sdk::{submit_and_wait_verification, get_next_nonce};
use aligned_sdk::types::{ProvingSystemId, VerificationData};
use ethers::prelude::*;

Expand All@@ -147,13 +148,33 @@ async fn submit_proof_to_aligned(
.await
.map_err(|e| anyhow::anyhow!("Failed to get next nonce: {:?}", e))?;

submit(BATCHER_URL, &verification_data, wallet, nonce).await
.map_err(|e| anyhow::anyhow!("Failed to submit proof: {:?}", e))
match submit_and_wait_verification(
BATCHER_URL,
&rpc_url,
Chain::Holesky,
&verification_data,
wallet.clone(),
nonce,
BATCHER_PAYMENTS_ADDRESS
)

submit_and_wait_verification(
BATCHER_URL,
RPC_URL,
Chain::Holesky,
&verification_data,
wallet,
nonce,
BATCHER_CONTRACT_ADDRESS
).await.map_err(|e| anyhow::anyhow!("Failed to submit proof: {:?}", e))
}

#[tokio::main]
async fn main() {
let wallet = // Initialize wallet

let wallet = wallet.with_chain_id(17000u64)

let proof = // Generate or obtain proof

match submit_proof_to_aligned(proof, wallet).await {
Expand All@@ -163,41 +184,6 @@ async fn main() {
}
```

The following code is an example of how to verify the proof was correctly verified in Aligned using the SDK:

```rust
use aligned_sdk::sdk::verify_proof_onchain;
use aligned_sdk::types::{AlignedVerificationData, Chain};
use ethers::prelude::*;
use tokio::time::{sleep, Duration};

async fn wait_for_proof_verification(
aligned_verification_data: AlignedVerificationData,
rpc_url: String,
) -> Result<(), anyhow::Error> {
for _ in 0..10 {
if verify_proof_onchain(aligned_verification_data.clone(), Chain::Holesky, rpc_url.as_str()).await.is_ok_and(|r| r) {
println!("Proof verified successfully.");
return Ok(());
}
println!("Proof not verified yet. Waiting 10 seconds before checking again...");
sleep(Duration::from_secs(10)).await;
}
anyhow::bail!("Proof verification failed")
}

#[tokio::main]
async fn main() {
let aligned_verification_data = // Obtain aligned verification data
let rpc_url = "https://ethereum-holesky-rpc.publicnode.com".to_string();

match wait_for_proof_verification(aligned_verification_data, rpc_url).await {
Ok(_) => println!("Proof verified"),
Err(err) => println!("Error: {:?}", err),
}
}
```

You can find an example of the proof submission and verification in the [ZKQuiz Program](../../examples/zkquiz/quiz/script/src/main.rs).

This example generates a proof, instantiates a wallet to submit the proof, and then submits the proof to Aligned for verification. It then waits for the proof to be verified in Aligned.
Expand Down
2 changes: 1 addition & 1 deletion examples/zkquiz/Makefile
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
deploy_verifier:
@. ./contracts/.env && . ./contracts/deploy.sh

CONTRACT_ADDRESS=0x8dB9e6f1393c3486F30181d606312ec632189621
CONTRACT_ADDRESS=0xA828f1463074d26FB761c662F80194f5dB2d31D0
RPC_URL=https://ethereum-holesky-rpc.publicnode.com
VERIFICATION_DATA=./aligned_verification_data/0a1fab5df88a71e48633cbdeedc8d1a234b790d15a8a2fd04cd6a03c1e05b5ef_212.json

Expand Down
1 change: 1 addition & 0 deletions examples/zkquiz/contracts/.env.example
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
RPC_URL=<rpc_url>
PRIVATE_KEY=<private_key>
ALIGNED_SERVICE_MANAGER_ADDRESS=<aligned_service_manager_addr># 0x58F280BeBE9B34c9939C3C39e0890C81f163B623 for Holesky
BATCHER_PAYMENT_SERVICE_ADDRESS=<batcher_payment_service_addr># 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
ETHERSCAN_API_KEY=<etherscan_api_key>
9 changes: 7 additions & 2 deletions examples/zkquiz/contracts/deploy.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,11 @@ if [ -z "$ALIGNED_SERVICE_MANAGER_ADDRESS" ]; then
exit 1
fi

if [ -z "$BATCHER_PAYMENT_SERVICE_ADDRESS" ]; then
echo "BATCHER_PAYMENT_SERVICE_ADDRESS is not set. Please set it in .env"
exit 1
fi

if [ -z "$RPC_URL" ]; then
echo "RPC_URL is not set. Please set it in .env"
exit 1
Expand All@@ -24,8 +29,8 @@ fi
forge install

forge script script/Deployer.s.sol \
"$ALIGNED_SERVICE_MANAGER_ADDRESS" \
"$ALIGNED_SERVICE_MANAGER_ADDRESS" "$BATCHER_PAYMENT_SERVICE_ADDRESS" \
--rpc-url "$RPC_URL" \
--private-key "$PRIVATE_KEY" \
--broadcast \
--sig "run(address _alignedServiceManager)"
--sig "run(address _alignedServiceManager, address _paymentService)"
10 changes: 8 additions & 2 deletions examples/zkquiz/contracts/script/Deployer.s.sol
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,16 @@ import {VerifierContract} from "../src/VerifierContract.sol";
contract CounterScript is Script {
function setUp() public {}

function run(address _targetContract) external returns (address) {
function run(
address _alignedServiceManager,
address _paymentService
) external returns (address) {
vm.startBroadcast();

VerifierContract verifyBatchInclusionCaller = new VerifierContract(_targetContract);
VerifierContract verifyBatchInclusionCaller = new VerifierContract(
_alignedServiceManager,
_paymentService
);

vm.stopBroadcast();

Expand Down
62 changes: 44 additions & 18 deletions examples/zkquiz/contracts/src/VerifierContract.sol
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,14 +8,20 @@ contract VerifierContract is ERC721URIStorage {
uint256 private _nextTokenId;

address public alignedServiceManager;
address public paymentServiceAddr;

bytes32 public elfCommitment = 0x35dd40ab04e180712996495caec915b8a7c488433acbb50c4d8d912cb55bf1f1;
bytes32 public elfCommitment =
0x35dd40ab04e180712996495caec915b8a7c488433acbb50c4d8d912cb55bf1f1;

// map to check if proof has already been submitted
mapping(bytes32 => bool) public mintedProofs;

constructor(address _alignedServiceManager) ERC721("Aligned Layer ZK Quiz", "AZKQ") {
constructor(
address _alignedServiceManager,
address _paymentServiceAddr
) ERC721("Aligned Layer ZK Quiz", "AZKQ") {
alignedServiceManager = _alignedServiceManager;
paymentServiceAddr = _paymentServiceAddr;
}

function verifyBatchInclusion(
Expand All@@ -27,25 +33,41 @@ contract VerifierContract is ERC721URIStorage {
bytes memory merkleProof,
uint256 verificationDataBatchIndex
) external returns (uint256) {
require(elfCommitment == provingSystemAuxDataCommitment, "ELF does not match");
require(address(proofGeneratorAddr) == msg.sender, "proofGeneratorAddr does not match");

bytes32 fullHash = keccak256(abi.encodePacked(proofCommitment,
pubInputCommitment, provingSystemAuxDataCommitment, proofGeneratorAddr));
require(!mintedProofs[fullHash], "proof already minted");
require(
elfCommitment == provingSystemAuxDataCommitment,
"ELF does not match"
);
require(
address(proofGeneratorAddr) == msg.sender,
"proofGeneratorAddr does not match"
);

(bool callWasSuccessfull, bytes memory proofIsIncluded) = alignedServiceManager.staticcall(
abi.encodeWithSignature(
"verifyBatchInclusion(bytes32,bytes32,bytes32,bytes20,bytes32,bytes,uint256)",
bytes32 fullHash = keccak256(
abi.encodePacked(
proofCommitment,
pubInputCommitment,
provingSystemAuxDataCommitment,
proofGeneratorAddr,
batchMerkleRoot,
merkleProof,
verificationDataBatchIndex
proofGeneratorAddr
)
);
require(!mintedProofs[fullHash], "proof already minted");

(
bool callWasSuccessfull,
bytes memory proofIsIncluded
) = alignedServiceManager.staticcall(
abi.encodeWithSignature(
"verifyBatchInclusion(bytes32,bytes32,bytes32,bytes20,bytes32,bytes,uint256,address)",
proofCommitment,
pubInputCommitment,
provingSystemAuxDataCommitment,
proofGeneratorAddr,
batchMerkleRoot,
merkleProof,
verificationDataBatchIndex,
paymentServiceAddr
)
);

require(callWasSuccessfull, "static_call failed");

Expand All@@ -56,15 +78,19 @@ contract VerifierContract is ERC721URIStorage {

uint256 tokenId = _nextTokenId++;
_mint(msg.sender, tokenId);
_setTokenURI(tokenId, "ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ");
_setTokenURI(
tokenId,
"ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ"
);

return tokenId;
}

function tokenURI(uint256 tokenId) public override view virtual returns (string memory) {
function tokenURI(
uint256 tokenId
) public view virtual override returns (string memory) {
_requireOwned(tokenId);

return "ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ";
}

}
4 changes: 3 additions & 1 deletion examples/zkquiz/quiz/program/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,4 +6,6 @@ edition = "2021"

[dependencies]
sp1-zkvm = { git = "https://github.com/succinctlabs/sp1.git", rev = "v1.0.8-testnet" }
tiny-keccak = { git = "https://github.com/sp1-patches/tiny-keccak", branch = "patch-v2.0.2", features = ["sha3"] }
tiny-keccak = { git = "https://github.com/sp1-patches/tiny-keccak", branch = "patch-v2.0.2", features = [
"sha3",
] }
52 changes: 51 additions & 1 deletion examples/zkquiz/quiz/script/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/zkquiz/quiz/script/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ edition = "2021"

[dependencies]
sp1-sdk = { git = "https://github.com/succinctlabs/sp1.git", rev = "v1.0.1" }
aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", tag = "v0.4.0" }
aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", rev = "6908110aaa04ec3107f15ab8a8bb2603e7bbead9" }
ethers = { tag = "v2.0.15-fix-reconnections", features = [
"ws",
"rustls",
Expand Down
2 changes: 1 addition & 1 deletion examples/zkquiz/quiz/script/VerifierContract.json

Large diffs are not rendered by default.

Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
66 changes: 26 additions & 40 deletions docs/guides/2_integrating_aligned_into_your_application.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -116,12 +116,13 @@ The proof submission and verification can be done either with the SDK or by usin

#### Using the SDK

To submit a proof using the SDK, you can use the `submit` function, and then you can use the `verify_proof_onchain` function to check if the proof was correctly verified in Aligned.

To submit a proof using the SDK, you can use the `submit_and_wait_verification` function.
This function submits the proof to aligned and waits for it to be verified in Aligned.
Alternatively you can call `submit` if you dont want to wait for proof verification.
The following code is an example of how to submit a proof using the SDK:

```rust
use aligned_sdk::sdk::{submit, get_next_nonce};
use aligned_sdk::sdk::{submit_and_wait_verification, get_next_nonce};
use aligned_sdk::types::{ProvingSystemId, VerificationData};
use ethers::prelude::*;

Expand All@@ -147,13 +148,33 @@ async fn submit_proof_to_aligned(
.await
.map_err(|e| anyhow::anyhow!("Failed to get next nonce: {:?}", e))?;

submit(BATCHER_URL, &verification_data, wallet, nonce).await
.map_err(|e| anyhow::anyhow!("Failed to submit proof: {:?}", e))
match submit_and_wait_verification(
BATCHER_URL,
&rpc_url,
Chain::Holesky,
&verification_data,
wallet.clone(),
nonce,
BATCHER_PAYMENTS_ADDRESS
)

submit_and_wait_verification(
BATCHER_URL,
RPC_URL,
Chain::Holesky,
&verification_data,
wallet,
nonce,
BATCHER_CONTRACT_ADDRESS
).await.map_err(|e| anyhow::anyhow!("Failed to submit proof: {:?}", e))
}

#[tokio::main]
async fn main() {
let wallet = // Initialize wallet

let wallet = wallet.with_chain_id(17000u64)

let proof = // Generate or obtain proof

match submit_proof_to_aligned(proof, wallet).await {
Expand All@@ -163,41 +184,6 @@ async fn main() {
}
```

The following code is an example of how to verify the proof was correctly verified in Aligned using the SDK:

```rust
use aligned_sdk::sdk::verify_proof_onchain;
use aligned_sdk::types::{AlignedVerificationData, Chain};
use ethers::prelude::*;
use tokio::time::{sleep, Duration};

async fn wait_for_proof_verification(
aligned_verification_data: AlignedVerificationData,
rpc_url: String,
) -> Result<(), anyhow::Error> {
for _ in 0..10 {
if verify_proof_onchain(aligned_verification_data.clone(), Chain::Holesky, rpc_url.as_str()).await.is_ok_and(|r| r) {
println!("Proof verified successfully.");
return Ok(());
}
println!("Proof not verified yet. Waiting 10 seconds before checking again...");
sleep(Duration::from_secs(10)).await;
}
anyhow::bail!("Proof verification failed")
}

#[tokio::main]
async fn main() {
let aligned_verification_data = // Obtain aligned verification data
let rpc_url = "https://ethereum-holesky-rpc.publicnode.com".to_string();

match wait_for_proof_verification(aligned_verification_data, rpc_url).await {
Ok(_) => println!("Proof verified"),
Err(err) => println!("Error: {:?}", err),
}
}
```

You can find an example of the proof submission and verification in the [ZKQuiz Program](../../examples/zkquiz/quiz/script/src/main.rs).

This example generates a proof, instantiates a wallet to submit the proof, and then submits the proof to Aligned for verification. It then waits for the proof to be verified in Aligned.
Expand Down
2 changes: 1 addition & 1 deletion examples/zkquiz/Makefile
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
deploy_verifier:
@. ./contracts/.env && . ./contracts/deploy.sh

CONTRACT_ADDRESS=0x8dB9e6f1393c3486F30181d606312ec632189621
CONTRACT_ADDRESS=0xA828f1463074d26FB761c662F80194f5dB2d31D0
RPC_URL=https://ethereum-holesky-rpc.publicnode.com
VERIFICATION_DATA=./aligned_verification_data/0a1fab5df88a71e48633cbdeedc8d1a234b790d15a8a2fd04cd6a03c1e05b5ef_212.json

Expand Down
1 change: 1 addition & 0 deletions examples/zkquiz/contracts/.env.example
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
RPC_URL=<rpc_url>
PRIVATE_KEY=<private_key>
ALIGNED_SERVICE_MANAGER_ADDRESS=<aligned_service_manager_addr># 0x58F280BeBE9B34c9939C3C39e0890C81f163B623 for Holesky
BATCHER_PAYMENT_SERVICE_ADDRESS=<batcher_payment_service_addr># 0x815aeCA64a974297942D2Bbf034ABEe22a38A003
ETHERSCAN_API_KEY=<etherscan_api_key>
9 changes: 7 additions & 2 deletions examples/zkquiz/contracts/deploy.sh
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,11 @@ if [ -z "$ALIGNED_SERVICE_MANAGER_ADDRESS" ]; then
exit 1
fi

if [ -z "$BATCHER_PAYMENT_SERVICE_ADDRESS" ]; then
echo "BATCHER_PAYMENT_SERVICE_ADDRESS is not set. Please set it in .env"
exit 1
fi

if [ -z "$RPC_URL" ]; then
echo "RPC_URL is not set. Please set it in .env"
exit 1
Expand All@@ -24,8 +29,8 @@ fi
forge install

forge script script/Deployer.s.sol \
"$ALIGNED_SERVICE_MANAGER_ADDRESS" \
"$ALIGNED_SERVICE_MANAGER_ADDRESS" "$BATCHER_PAYMENT_SERVICE_ADDRESS" \
--rpc-url "$RPC_URL" \
--private-key "$PRIVATE_KEY" \
--broadcast \
--sig "run(address _alignedServiceManager)"
--sig "run(address _alignedServiceManager, address _paymentService)"
10 changes: 8 additions & 2 deletions examples/zkquiz/contracts/script/Deployer.s.sol
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,16 @@ import {VerifierContract} from "../src/VerifierContract.sol";
contract CounterScript is Script {
function setUp() public {}

function run(address _targetContract) external returns (address) {
function run(
address _alignedServiceManager,
address _paymentService
) external returns (address) {
vm.startBroadcast();

VerifierContract verifyBatchInclusionCaller = new VerifierContract(_targetContract);
VerifierContract verifyBatchInclusionCaller = new VerifierContract(
_alignedServiceManager,
_paymentService
);

vm.stopBroadcast();

Expand Down
62 changes: 44 additions & 18 deletions examples/zkquiz/contracts/src/VerifierContract.sol
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,14 +8,20 @@ contract VerifierContract is ERC721URIStorage {
uint256 private _nextTokenId;

address public alignedServiceManager;
address public paymentServiceAddr;

bytes32 public elfCommitment = 0x35dd40ab04e180712996495caec915b8a7c488433acbb50c4d8d912cb55bf1f1;
bytes32 public elfCommitment =
0x35dd40ab04e180712996495caec915b8a7c488433acbb50c4d8d912cb55bf1f1;

// map to check if proof has already been submitted
mapping(bytes32 => bool) public mintedProofs;

constructor(address _alignedServiceManager) ERC721("Aligned Layer ZK Quiz", "AZKQ") {
constructor(
address _alignedServiceManager,
address _paymentServiceAddr
) ERC721("Aligned Layer ZK Quiz", "AZKQ") {
alignedServiceManager = _alignedServiceManager;
paymentServiceAddr = _paymentServiceAddr;
}

function verifyBatchInclusion(
Expand All@@ -27,25 +33,41 @@ contract VerifierContract is ERC721URIStorage {
bytes memory merkleProof,
uint256 verificationDataBatchIndex
) external returns (uint256) {
require(elfCommitment == provingSystemAuxDataCommitment, "ELF does not match");
require(address(proofGeneratorAddr) == msg.sender, "proofGeneratorAddr does not match");

bytes32 fullHash = keccak256(abi.encodePacked(proofCommitment,
pubInputCommitment, provingSystemAuxDataCommitment, proofGeneratorAddr));
require(!mintedProofs[fullHash], "proof already minted");
require(
elfCommitment == provingSystemAuxDataCommitment,
"ELF does not match"
);
require(
address(proofGeneratorAddr) == msg.sender,
"proofGeneratorAddr does not match"
);

(bool callWasSuccessfull, bytes memory proofIsIncluded) = alignedServiceManager.staticcall(
abi.encodeWithSignature(
"verifyBatchInclusion(bytes32,bytes32,bytes32,bytes20,bytes32,bytes,uint256)",
bytes32 fullHash = keccak256(
abi.encodePacked(
proofCommitment,
pubInputCommitment,
provingSystemAuxDataCommitment,
proofGeneratorAddr,
batchMerkleRoot,
merkleProof,
verificationDataBatchIndex
proofGeneratorAddr
)
);
require(!mintedProofs[fullHash], "proof already minted");

(
bool callWasSuccessfull,
bytes memory proofIsIncluded
) = alignedServiceManager.staticcall(
abi.encodeWithSignature(
"verifyBatchInclusion(bytes32,bytes32,bytes32,bytes20,bytes32,bytes,uint256,address)",
proofCommitment,
pubInputCommitment,
provingSystemAuxDataCommitment,
proofGeneratorAddr,
batchMerkleRoot,
merkleProof,
verificationDataBatchIndex,
paymentServiceAddr
)
);

require(callWasSuccessfull, "static_call failed");

Expand All@@ -56,15 +78,19 @@ contract VerifierContract is ERC721URIStorage {

uint256 tokenId = _nextTokenId++;
_mint(msg.sender, tokenId);
_setTokenURI(tokenId, "ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ");
_setTokenURI(
tokenId,
"ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ"
);

return tokenId;
}

function tokenURI(uint256 tokenId) public override view virtual returns (string memory) {
function tokenURI(
uint256 tokenId
) public view virtual override returns (string memory) {
_requireOwned(tokenId);

return "ipfs://QmUKviny9x2oQUegyJFFBAUU2q5rvu5CsPzrUaBSDukpHQ";
}

}
4 changes: 3 additions & 1 deletion examples/zkquiz/quiz/program/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,4 +6,6 @@ edition = "2021"

[dependencies]
sp1-zkvm = { git = "https://github.com/succinctlabs/sp1.git", rev = "v1.0.8-testnet" }
tiny-keccak = { git = "https://github.com/sp1-patches/tiny-keccak", branch = "patch-v2.0.2", features = ["sha3"] }
tiny-keccak = { git = "https://github.com/sp1-patches/tiny-keccak", branch = "patch-v2.0.2", features = [
"sha3",
] }
52 changes: 51 additions & 1 deletion examples/zkquiz/quiz/script/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/zkquiz/quiz/script/Cargo.toml
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,7 +6,7 @@ edition = "2021"

[dependencies]
sp1-sdk = { git = "https://github.com/succinctlabs/sp1.git", rev = "v1.0.1" }
aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", tag = "v0.4.0" }
aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", rev = "6908110aaa04ec3107f15ab8a8bb2603e7bbead9" }
ethers = { tag = "v2.0.15-fix-reconnections", features = [
"ws",
"rustls",
Expand Down
2 changes: 1 addition & 1 deletion examples/zkquiz/quiz/script/VerifierContract.json

Large diffs are not rendered by default.

Loading