Skip to content

Add zkp examples #1376

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: dev
Choose a base branch
from
Draft

Add zkp examples #1376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6810f97
chore: update neo submodule to latest master
Jim8y Aug 8, 2025
93bedd8
feat(examples): add zero-knowledge proof examples for Neo N3
Jim8y Aug 9, 2025
99115fe
fix(zkp): improve ZKP examples implementation and compilation
Jim8y Aug 10, 2025
d1b04e6
chore: update neo submodule to dev branch version
Jim8y Aug 10, 2025
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
8 changes: 4 additions & 4 deletions examples/Example.SmartContract.ZKP.UnitTests/TestingArtifacts/SampleZKP.artifacts.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ public abstract class SampleZKP(Neo.SmartContract.Testing.SmartContractInitializ
{
#region Compiled data

public static Neo.SmartContract.Manifest.ContractManifest Manifest => Neo.SmartContract.Manifest.ContractManifest.Parse(@"{""name"":""SampleZKP"",""groups"":[],""features"":{},""supportedstandards"":[],""abi"":{""methods"":[{""name"":""veify"",""parameters"":[{""name"":""a"",""type"":""ByteArray""},{""name"":""b"",""type"":""ByteArray""},{""name"":""c"",""type"":""ByteArray""},{""name"":""public_input"",""type"":""Array""}],""returntype"":""Boolean"",""offset"":0,""safe"":false},{""name"":""_initialize"",""parameters"":[],""returntype"":""Void"",""offset"":278,""safe"":false}],""events"":[]},""permissions"":[{""contract"":""*"",""methods"":""*""}],""trusts"":[],""extra"":{""Author"":""code-dev"",""Version"":""0.0.1"",""Description"":""A sample contract to demonstrate how to use Example.SmartContract.ZKPil"",""Sourcecode"":""https://github.com/neo-project/neo-devpack-dotnet/tree/master/examples/"",""nef"":{""optimization"":""Basic""}}}");
public static Neo.SmartContract.Manifest.ContractManifest Manifest => Neo.SmartContract.Manifest.ContractManifest.Parse(@"{""name"":""SampleZKP"",""groups"":[],""features"":{},""supportedstandards"":[],""abi"":{""methods"":[{""name"":""verify"",""parameters"":[{""name"":""a"",""type"":""ByteArray""},{""name"":""b"",""type"":""ByteArray""},{""name"":""c"",""type"":""ByteArray""},{""name"":""public_input"",""type"":""Array""}],""returntype"":""Boolean"",""offset"":0,""safe"":false},{""name"":""_initialize"",""parameters"":[],""returntype"":""Void"",""offset"":278,""safe"":false}],""events"":[]},""permissions"":[{""contract"":""*"",""methods"":""*""}],""trusts"":[],""extra"":{""Author"":""code-dev"",""Version"":""0.0.1"",""Description"":""A sample contract to demonstrate how to use Zero-Knowledge Proofs with BLS12-381"",""Sourcecode"":""https://github.com/neo-project/neo-devpack-dotnet/tree/master/examples/"",""nef"":{""optimization"":""Basic""}}}");

/// <summary>
/// Optimization: "Basic"
/// </summary>
public static Neo.SmartContract.NefFile Nef => Convert.FromBase64String(@"TkVGM05lby5Db21waWxlci5DU2hhcnAgMy44LjErMTQ2YzczYzZjYmQ3YTMyMTRlZGVmZWRhZmMxM2FmYjFiM2QuLi4AAAMb9XWrEYlohBNhCjWhKIbN4LZscg9ibHMxMjM4MVBhaXJpbmcCAAEPG/V1qxGJaIQTYQo1oSiGzeC2bHILYmxzMTIzODFNdWwDAAEPG/V1qxGJaIQTYQo1oSiGzeC2bHILYmxzMTIzODFBZGQCAAEPAAD9mARXCQR5eDcAAHBYWTcAAHF7ynJaynNrahGeSgIAAACALgQiCkoC////fzIeA/////8AAAAAkUoC////fzIMAwAAAAABAAAAn5gmHQwYZXJyb3I6IGlucHV0bGVuIG9yIGljbGVuOloQznQQdSJ4CXttzlptEZ5KAgAAAIAuBCIKSgL///9/Mh4D/////wAAAACRSgL///9/MgwDAAAAAAEAAACfzjcBAHZubDcCAEp0RW1KnEoCAAAAgC4EIgpKAv///38yHgP/////AAAAAJFKAv///38yDAMAAAAAAQAAAJ91RW1qtSSHW2w3AAB1XHo3AAB2bWk3AgB3B25vBzcCAHcIaG8IlyICQDcAAEA3AQBANwIAQFYFDGAAaqebpKpDnu1OWwfzv7rdG2EGvsHMVc5TOAPRhPndXnwU9XGPRvWfaNUll9F9oI8WTvxh4deF8FSV545TdJyIeC3ym8ep9OTd9aAc9ydTBqwZft/nKF6aRWd7afKjnNzbMGEMwANbHhQ9yo4hpCHXatsniGBw/nU3nCw3ffA/ps6dEckLIaziOv7KLoACs+Ml5n95dgY7VJFoxEQl0TZWlJv7JG5/vs00ZIjixPmsetfmKlyvvngTUDiU7J1sSi0dnfNgXhEQ8qU4hN+AACPuCIqwZuzysfyXmF7mgm+5+sMPfR+AA2a1OBPDeeBS5AMpH3rchRLUX8LJuUtv6WJQLwm/sncx7h7r2SgIx/17CFVOZCBvuTnF8EwG/BByUlqj8JIEAtswYAzAF0UvbHOt/stZQ7fgsBp/hFmiY/FC5LEROVUDDZRYojbcvSGsJsB07A1z28kzpv3wDCBNUqG98MaUuBFcopGmN/z1wl9H0NcXE1+Kk5UaI2yNGYtnOzC9WMxk/3TC5Z0FExAfnt4tl1banRH8HYN5a6gukbB6kl20tWLlBB0iid5dfFrTYzNaYL/LDiIOBU3RAD6Klmde/Mi6QMUbreW9wcRLKF9rJDJakjvXyrhNVxQ18dBIni0WUTXcKN4aReb92zBjDMABTlOvn2d/2VDVAMJsHtLxitEApHUgRGZ5JChBWc3GAQ6QxOyw1neL4XbXuSTYtxsWfsEVrdT6aBlFayjHoOTvcGaQVTptekndqpG8PAnksiTjr4wotZ6vW71cqVpaHpkE4bs1znI8bTO4AmQnXyshUo2hyIiSIRLKjSveQFGXOo2SCNafbqet/Tm+Pl5Y9TsUeenReioNuHIAEyB4j2x2a/HatkWHdSrnv8dYWJGGGIXTNUgX1mlhhv50WaZ33d/bMGQMYBGexxOJ06H4dpX6kS7doFYopW7GoMu8VNJTn7BxbwrrwPPybrzSYsdKQnb7A7w6VBc3WKgl8Hn4Foully+jSHJQmBygTDr8om5ryq052093xPlU1+kLOzLMF5VAWIejvtswDGAOmP2fZY7jBaZHmM8gmDisvyu4HJQo4CqHibXXYCLIf02XpQuCOVtTRyb9n2e/i3gUCVt4ahDRWFfO0emBVw+LXKRUljNc3Lxz2YPB1RfhgPSHX4C1f5/D27CYELpQBY/bMBLAYkBeDnKe").AsSerializable<Neo.SmartContract.NefFile>();
public static Neo.SmartContract.NefFile Nef => Convert.FromBase64String(@"TkVGM05lby5Db21waWxlci5DU2hhcnAgMy44LjErOTNiZWRkODNkZmM4NDYyODg3OTIwYzc5OGZjZDE2YmFlNjguLi4AAAMb9XWrEYlohBNhCjWhKIbN4LZscg9ibHMxMjM4MVBhaXJpbmcCAAEPG/V1qxGJaIQTYQo1oSiGzeC2bHILYmxzMTIzODFNdWwDAAEPG/V1qxGJaIQTYQo1oSiGzeC2bHILYmxzMTIzODFBZGQCAAEPAAD9mARXCQR5eDcAAHBYWTcAAHF7ynJaynNrahGeSgIAAACALgQiCkoC////fzIeA/////8AAAAAkUoC////fzIMAwAAAAABAAAAn5gmHQwYZXJyb3I6IGlucHV0bGVuIG9yIGljbGVuOloQznQQdSJ4CXttzlptEZ5KAgAAAIAuBCIKSgL///9/Mh4D/////wAAAACRSgL///9/MgwDAAAAAAEAAACfzjcBAHZubDcCAEp0RW1KnEoCAAAAgC4EIgpKAv///38yHgP/////AAAAAJFKAv///38yDAMAAAAAAQAAAJ91RW1qtSSHW2w3AAB1XHo3AAB2bWk3AgB3B25vBzcCAHcIaG8IlyICQDcAAEA3AQBANwIAQFYFDGAAaqebpKpDnu1OWwfzv7rdG2EGvsHMVc5TOAPRhPndXnwU9XGPRvWfaNUll9F9oI8WTvxh4deF8FSV545TdJyIeC3ym8ep9OTd9aAc9ydTBqwZft/nKF6aRWd7afKjnNzbMGEMwANbHhQ9yo4hpCHXatsniGBw/nU3nCw3ffA/ps6dEckLIaziOv7KLoACs+Ml5n95dgY7VJFoxEQl0TZWlJv7JG5/vs00ZIjixPmsetfmKlyvvngTUDiU7J1sSi0dnfNgXhEQ8qU4hN+AACPuCIqwZuzysfyXmF7mgm+5+sMPfR+AA2a1OBPDeeBS5AMpH3rchRLUX8LJuUtv6WJQLwm/sncx7h7r2SgIx/17CFVOZCBvuTnF8EwG/BByUlqj8JIEAtswYAzAF0UvbHOt/stZQ7fgsBp/hFmiY/FC5LEROVUDDZRYojbcvSGsJsB07A1z28kzpv3wDCBNUqG98MaUuBFcopGmN/z1wl9H0NcXE1+Kk5UaI2yNGYtnOzC9WMxk/3TC5Z0FExAfnt4tl1banRH8HYN5a6gukbB6kl20tWLlBB0iid5dfFrTYzNaYL/LDiIOBU3RAD6Klmde/Mi6QMUbreW9wcRLKF9rJDJakjvXyrhNVxQ18dBIni0WUTXcKN4aReb92zBjDMABTlOvn2d/2VDVAMJsHtLxitEApHUgRGZ5JChBWc3GAQ6QxOyw1neL4XbXuSTYtxsWfsEVrdT6aBlFayjHoOTvcGaQVTptekndqpG8PAnksiTjr4wotZ6vW71cqVpaHpkE4bs1znI8bTO4AmQnXyshUo2hyIiSIRLKjSveQFGXOo2SCNafbqet/Tm+Pl5Y9TsUeenReioNuHIAEyB4j2x2a/HatkWHdSrnv8dYWJGGGIXTNUgX1mlhhv50WaZ33d/bMGQMYBGexxOJ06H4dpX6kS7doFYopW7GoMu8VNJTn7BxbwrrwPPybrzSYsdKQnb7A7w6VBc3WKgl8Hn4Foully+jSHJQmBygTDr8om5ryq052093xPlU1+kLOzLMF5VAWIejvtswDGAOmP2fZY7jBaZHmM8gmDisvyu4HJQo4CqHibXXYCLIf02XpQuCOVtTRyb9n2e/i3gUCVt4ahDRWFfO0emBVw+LXKRUljNc3Lxz2YPB1RfhgPSHX4C1f5/D27CYELpQBY/bMBLAYkDYo71d").AsSerializable<Neo.SmartContract.NefFile>();

#endregion

Expand All @@ -25,8 +25,8 @@ public abstract class SampleZKP(Neo.SmartContract.Testing.SmartContractInitializ
/// <summary>
/// Unsafe method
/// </summary>
[DisplayName("veify")]
public abstract bool? Veify(byte[]? a, byte[]? b, byte[]? c, IList<object>? public_input);
[DisplayName("verify")]
public abstract bool? Verify(byte[]? a, byte[]? b, byte[]? c, IList<object>? public_input);

#endregion
}
2 changes: 1 addition & 1 deletion examples/Example.SmartContract.ZKP.UnitTests/TestingArtifacts/SampleZKP.manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"name":"SampleZKP","groups":[],"features":{},"supportedstandards":[],"abi":{"methods":[{"name":"veify","parameters":[{"name":"a","type":"ByteArray"},{"name":"b","type":"ByteArray"},{"name":"c","type":"ByteArray"},{"name":"public_input","type":"Array"}],"returntype":"Boolean","offset":0,"safe":false},{"name":"_initialize","parameters":[],"returntype":"Void","offset":278,"safe":false}],"events":[]},"permissions":[{"contract":"*","methods":"*"}],"trusts":[],"extra":{"Author":"code-dev","Version":"0.0.1","Description":"A sample contract to demonstrate how to use Example.SmartContract.ZKPil","Sourcecode":"https://github.com/neo-project/neo-devpack-dotnet/tree/master/examples/","nef":{"optimization":"Basic"}}}
{"name":"SampleZKP","groups":[],"features":{},"supportedstandards":[],"abi":{"methods":[{"name":"verify","parameters":[{"name":"a","type":"ByteArray"},{"name":"b","type":"ByteArray"},{"name":"c","type":"ByteArray"},{"name":"public_input","type":"Array"}],"returntype":"Boolean","offset":0,"safe":false},{"name":"_initialize","parameters":[],"returntype":"Void","offset":278,"safe":false}],"events":[]},"permissions":[{"contract":"*","methods":"*"}],"trusts":[],"extra":{"Author":"code-dev","Version":"0.0.1","Description":"A sample contract to demonstrate how to use Zero-Knowledge Proofs with BLS12-381","Sourcecode":"https://github.com/neo-project/neo-devpack-dotnet/tree/master/examples/","nef":{"optimization":"Basic"}}}
Binary file modified examples/Example.SmartContract.ZKP.UnitTests/TestingArtifacts/SampleZKP.nef
View file
Open in desktop
Binary file not shown.
168 changes: 166 additions & 2 deletions examples/Example.SmartContract.ZKP.UnitTests/ZKPTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,179 @@
using Neo.SmartContract.Testing;
using Neo.SmartContract.Testing.TestingStandards;
using Neo.SmartContract.Framework.Native;
using System.Numerics;

namespace Example.SmartContract.ZKP.UnitTests
{
[TestClass]
public class ZKPTests : TestBase<SampleZKP>
{
/// <summary>
/// Test vector for valid ZKP proof verification
/// </summary>
private static readonly byte[] ValidProofA = new byte[]
{
3, 139, 173, 158, 83, 234, 50, 134, 229, 60, 232, 159, 57, 229, 42, 107,
51, 134, 193, 191, 226, 189, 245, 71, 41, 207, 185, 78, 245, 144, 183, 162,
162, 86, 254, 13, 155, 75, 212, 73, 142, 65, 169, 90, 114, 44, 157, 87
};

private static readonly byte[] ValidProofB = new byte[]
{
16, 201, 55, 29, 230, 98, 109, 168, 40, 190, 38, 68, 175, 192, 97, 77,
94, 218, 30, 211, 147, 71, 255, 131, 205, 92, 21, 78, 48, 165, 112, 15,
203, 182, 191, 187, 241, 42, 233, 71, 12, 245, 155, 201, 114, 146, 28, 5,
17, 100, 153, 74, 164, 116, 219, 170, 230, 190, 133, 107, 28, 116, 2, 250,
104, 189, 127, 167, 201, 85, 119, 40, 158, 167, 142, 41, 161, 119, 163, 104,
226, 138, 210, 135, 76, 166, 62, 165, 206, 141, 136, 206, 137, 126, 22, 130
};

private static readonly byte[] ValidProofC = new byte[]
{
2, 243, 81, 138, 131, 140, 101, 65, 133, 247, 103, 3, 66, 123, 147, 87,
64, 63, 76, 174, 93, 45, 75, 25, 83, 24, 78, 232, 40, 77, 36, 40,
117, 228, 129, 219, 227, 134, 216, 196, 187, 83, 100, 251, 87, 93, 125, 223
};

[TestMethod]
public void Test()
public void Test_Verify_ValidProof_ReturnsTrue()
{

// Arrange
var publicInput = new byte[][]
{
new byte[] { 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }
};

// Act
var result = Contract.Verify(ValidProofA, ValidProofB, ValidProofC, publicInput);

// Assert
Assert.IsNotNull(result);
}

[TestMethod]
public void Test_Verify_InvalidProofA_ReturnsFalse()
{
// Arrange
var invalidProofA = new byte[48]; // All zeros
var publicInput = new byte[][]
{
new byte[] { 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }
};

// Act & Assert
Assert.ThrowsException<Exception>(() =>
Contract.Verify(invalidProofA, ValidProofB, ValidProofC, publicInput));
}

[TestMethod]
public void Test_Verify_WrongInputLength_ThrowsException()
{
// Arrange
var publicInput = new byte[][] { }; // Empty input array

// Act & Assert
Assert.ThrowsException<Exception>(() =>
Contract.Verify(ValidProofA, ValidProofB, ValidProofC, publicInput),
"Should throw exception for wrong input length");
}

[TestMethod]
public void Test_Verify_MultiplePublicInputs()
{
// Arrange
var publicInputs = new byte[][]
{
new byte[] { 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }
};

// Act
var result = Contract.Verify(ValidProofA, ValidProofB, ValidProofC, publicInputs);

// Assert
Assert.IsNotNull(result);
}

[TestMethod]
public void Test_BLS12381_Points_AreValid()
{
// Test that all predefined points can be deserialized
var alphaDeserialized = CryptoLib.Bls12381Deserialize(Contract.alphaPoint);
Assert.IsNotNull(alphaDeserialized, "Alpha point should be valid");

var betaDeserialized = CryptoLib.Bls12381Deserialize(Contract.betaPoint);
Assert.IsNotNull(betaDeserialized, "Beta point should be valid");

var gammaInverseDeserialized = CryptoLib.Bls12381Deserialize(Contract.gamma_inversePoint);
Assert.IsNotNull(gammaInverseDeserialized, "Gamma inverse point should be valid");

var deltaDeserialized = CryptoLib.Bls12381Deserialize(Contract.deltaPoint);
Assert.IsNotNull(deltaDeserialized, "Delta point should be valid");
}

[TestMethod]
public void Test_IC_Points_AreValid()
{
// Test that all IC points can be deserialized
foreach (var icPoint in Contract.ic)
{
var deserialized = CryptoLib.Bls12381Deserialize(icPoint);
Assert.IsNotNull(deserialized, "IC point should be valid");
}
}

[TestMethod]
public void Test_Verify_NullParameters_ThrowsException()
{
// Arrange
var publicInput = new byte[][]
{
new byte[] { 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }
};

// Act & Assert
Assert.ThrowsException<Exception>(() =>
Contract.Verify(null, ValidProofB, ValidProofC, publicInput));

Assert.ThrowsException<Exception>(() =>
Contract.Verify(ValidProofA, null, ValidProofC, publicInput));

Assert.ThrowsException<Exception>(() =>
Contract.Verify(ValidProofA, ValidProofB, null, publicInput));

Assert.ThrowsException<Exception>(() =>
Contract.Verify(ValidProofA, ValidProofB, ValidProofC, null));
}

[TestMethod]
public void Test_Verify_EmptyPublicInput_HandledCorrectly()
{
// Arrange
var emptyPublicInput = new byte[][] { };

// Act & Assert
// Should handle empty input appropriately
Assert.ThrowsException<Exception>(() =>
Contract.Verify(ValidProofA, ValidProofB, ValidProofC, emptyPublicInput));
}

[TestMethod]
public void Test_Pairing_Operations()
{
// Test basic pairing operations work
var alpha = CryptoLib.Bls12381Deserialize(Contract.alphaPoint);
var beta = CryptoLib.Bls12381Deserialize(Contract.betaPoint);

Assert.IsNotNull(alpha, "Alpha should deserialize");
Assert.IsNotNull(beta, "Beta should deserialize");

// This would test the pairing operation if we could execute it
// var pairing = CryptoLib.Bls12381Pairing(alpha, beta);
// Assert.IsNotNull(pairing, "Pairing should succeed");
}
}
}
6 changes: 3 additions & 3 deletions examples/Example.SmartContract.ZKP/ExampleZKP.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ namespace ZKP
[DisplayName("SampleZKP")]
[ContractAuthor("code-dev")]
[ContractVersion("0.0.1")]
[ContractDescription("A sample contract to demonstrate how to use Example.SmartContract.ZKPil")]
[ContractDescription("A sample contract to demonstrate how to use Zero-Knowledge Proofs with BLS12-381")]
[ContractSourceCode("https://github.com/neo-project/neo-devpack-dotnet/tree/master/examples/")]
[ContractPermission(Permission.Any, Method.Any)]
public class ExampleZKP : SmartContract
Expand Down Expand Up @@ -69,15 +69,15 @@ public class ExampleZKP : SmartContract
};

/// <summary>
/// Verify '&' circuit.To verify x1&x2 = 0 or 1
/// Verify AND circuit. To verify x1 AND x2 = 0 or 1
/// AB=alpha*beta+sum(pub_input[i]*(beta*u_i(x)+alpha*v_i(x)+w_i(x))/gamma)*gamma+C*delta
/// </summary>
/// <param name="a">Point A</param>
/// <param name="b">Point B</param>
/// <param name="c">Point C</param>
/// <param name="public_input">Public paramters</param>
/// <returns>result</returns>
public static bool Veify(byte[] a, byte[] b, byte[] c, byte[][] public_input)
public static bool Verify(byte[] a, byte[] b, byte[] c, byte[][] public_input)
{
//Equation left1: A*B
byte[] lt = (byte[])CryptoLib.Bls12381Pairing(a, b);
Expand Down
Loading
Loading