Skip to content

[NEP25] - Validate circular reference #4258

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

Merged
merged 4 commits into from
Oct 30, 2025
Merged

[NEP25] - Validate circular reference #4258

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
1365ed2
Extend ValidateExtendedTypes to check circle references
ajara87 Oct 28, 2025
e283a3f
remove unused usings
ajara87 Oct 28, 2025
c905d26
Add more tests and change enum
ajara87 Oct 29, 2025
e133f86
Add assert to valid tests
ajara87 Oct 29, 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
30 changes: 30 additions & 0 deletions src/Neo/SmartContract/Manifest/ContractAbi.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ namespace Neo.SmartContract.Manifest
public class ContractAbi : IInteroperable
{
private IReadOnlyDictionary<(string, int), ContractMethodDescriptor>? _methodDictionary;
private const int STATE_UNCHECK = 0;
private const int STATE_CHECKING = 1;
private const int STATE_CHECK = 2;

/// <summary>
/// Gets the methods in the ABI.
Expand Down Expand Up @@ -111,6 +114,27 @@ public static ContractAbi FromJson(JObject json)
return abi;
}

private static bool HasCircularReference(string name, IReadOnlyDictionary<string, ExtendedType> namedTypes, Dictionary<string, int> states)
{
if (!states.TryGetValue(name, out var state))
state = STATE_UNCHECK;

if (state == STATE_CHECKING) return true;
if (state == STATE_CHECK) return false;

states[name] = STATE_CHECKING;

var next = namedTypes[name].NamedType;
if (next is not null && namedTypes.ContainsKey(next))
{
if (HasCircularReference(next, namedTypes, states))
return true;
}

states[name] = STATE_CHECK;
return false;
}

internal void ValidateExtendedTypes()
{
ISet<string> knownNamedTypes = NamedTypes != null
Expand All @@ -119,9 +143,15 @@ internal void ValidateExtendedTypes()

if (NamedTypes != null)
{
var states = new Dictionary<string, int>(NamedTypes.Count, StringComparer.Ordinal);
foreach (var (name, type) in NamedTypes)
{
ExtendedType.EnsureValidNamedTypeIdentifier(name);
if (HasCircularReference(name, NamedTypes, states))
{
throw new FormatException($"Circular reference in namedtypes starting at '{name}'");
}

type.ValidateForNamedTypeDefinition(name, knownNamedTypes);
}
}
Expand Down
194 changes: 193 additions & 1 deletion tests/Neo.UnitTests/SmartContract/Manifest/UT_ExtendedType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ public void FromStackItem_ShouldThrow_WhenTypeMissing()
}

[TestMethod]
public void FromJson_Circular_Reference_ShouldThrow()
public void FromJson_Circular_Reference_A_A_ShouldThrow()
{
var json = (JObject)JToken.Parse(@"
{
Expand All @@ -326,5 +326,197 @@ public void FromJson_Circular_Reference_ShouldThrow()

Assert.ThrowsExactly<FormatException>(() => ContractAbi.FromJson(json));
}

[TestMethod]
public void FromJson_Circular_Reference_A_B_B_A_ShouldThrow()
{
var json = (JObject)JToken.Parse(@"
{
""methods"": [
{ ""name"": ""_deploy"", ""parameters"": [], ""returntype"": ""Void"", ""offset"": 0, ""safe"": true}
],
""events"": [],
""namedtypes"": {
""boo"": {
""type"": ""Array"",
""namedtype"": ""alice""
},
""alice"": {
""type"": ""Array"",
""namedtype"": ""boo""
}
}
}");

Assert.ThrowsExactly<FormatException>(() => ContractAbi.FromJson(json));
}

[TestMethod]
public void FromJson_Circular_Reference_A_B_C_A_ShouldThrow()
{
var json = (JObject)JToken.Parse(@"
{
""methods"": [
{ ""name"": ""_deploy"", ""parameters"": [], ""returntype"": ""Void"", ""offset"": 0, ""safe"": true}
],
""events"": [],
""namedtypes"": {
""boo"": {
""type"": ""Array"",
""namedtype"": ""alice""
},
""alice"": {
""type"": ""Array"",
""namedtype"": ""toc""
},
""toc"": {
""type"": ""Array"",
""namedtype"": ""boo""
}
}
}");

Assert.ThrowsExactly<FormatException>(() => ContractAbi.FromJson(json));
}

[TestMethod]
public void FromJson_Circular_Reference_A_B_C_B_ShouldThrow()
{
var json = (JObject)JToken.Parse(@"
{
""methods"": [
{ ""name"": ""_deploy"", ""parameters"": [], ""returntype"": ""Void"", ""offset"": 0, ""safe"": true}
],
""events"": [],
""namedtypes"": {
""boo"": {
""type"": ""Array"",
""namedtype"": ""alice""
},
""alice"": {
""type"": ""Array"",
""namedtype"": ""toc""
},
""toc"": {
""type"": ""Array"",
""namedtype"": ""alice""
}
}
}");

Assert.ThrowsExactly<FormatException>(() => ContractAbi.FromJson(json));
}

[TestMethod]
public void FromJson_No_Circular_Reference_A_B_C()
{
var json = (JObject)JToken.Parse(@"
{
""methods"": [
{ ""name"": ""_deploy"", ""parameters"": [], ""returntype"": ""Void"", ""offset"": 0, ""safe"": true}
],
""events"": [],
""namedtypes"": {
""boo"": {
""type"": ""Array"",
""namedtype"": ""alice""
},
""alice"": {
""type"": ""Array"",
""namedtype"": ""toc""
},
""toc"":{
""type"": ""Array"",
""value"": {""type"": ""Integer"" }
}
}
}");

var result = ContractAbi.FromJson(json);
Assert.IsTrue(result.NamedTypes.ContainsKey("boo"));
Assert.IsTrue(result.NamedTypes.ContainsKey("alice"));
Assert.IsTrue(result.NamedTypes.ContainsKey("toc"));
}

[TestMethod]
public void FromJson_Circular_Reference_A_NO_B_A_C_A()
{
// A => No namedtype
// B => A
// C => A
var json = (JObject)JToken.Parse(@"
{
""methods"": [
{ ""name"": ""_deploy"", ""parameters"": [], ""returntype"": ""Void"", ""offset"": 0, ""safe"": true}
],
""events"": [],
""namedtypes"": {
""boo"": {
""type"": ""Array"",
""value"": {""type"": ""Integer"" }
},
""alice"": {
""type"": ""Array"",
""namedtype"": ""boo""
},
""toc"": {
""type"": ""Array"",
""namedtype"": ""boo""
}
}
}");

var result = ContractAbi.FromJson(json);
Assert.IsTrue(result.NamedTypes.ContainsKey("boo"));
Assert.IsTrue(result.NamedTypes.ContainsKey("alice"));
Assert.IsTrue(result.NamedTypes.ContainsKey("toc"));
}

[TestMethod]
public void FromJson_Circular_Reference_A_VALUE_A()
{
var json = (JObject)JToken.Parse(@"
{
""methods"": [
{ ""name"": ""_deploy"", ""parameters"": [], ""returntype"": ""Void"", ""offset"": 0, ""safe"": true}
],
""events"": [],
""namedtypes"": {
""boo"": {
""type"": ""Array"",
""value"": {""type"":""Array"",""namedtype"": ""boo"" }
}
}
}");

var result = ContractAbi.FromJson(json);
Assert.IsTrue(result.NamedTypes.ContainsKey("boo"));
}

[TestMethod]
public void FromJson_Circular_Reference_A_VALUE_B_B_VALUE_A()
{
var json = (JObject)JToken.Parse(@"
{
""methods"": [
{ ""name"": ""_deploy"", ""parameters"": [], ""returntype"": ""Void"", ""offset"": 0, ""safe"": true}
],
""events"": [],
""namedtypes"": {
""boo"": {
""type"": ""Array"",
""value"": {""type"":""Array"",""namedtype"": ""alice"" }
},
""alice"": {
""type"": ""Array"",
""value"": {""type"":""Array"",""namedtype"": ""boo"" }
}
}
}");

var result = ContractAbi.FromJson(json);
Assert.IsTrue(result.NamedTypes.ContainsKey("boo"));
Assert.IsTrue(result.NamedTypes.ContainsKey("alice"));
}
}
}