-
Notifications
You must be signed in to change notification settings - Fork 1k
Implement NotaryAssisted transaction attribute #3175
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.
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
Changes from all commits
6da4ae2
acec1b0
1508d4f
8b547c9
b16a28c
00b54ff
24135ff
2fb879d
a260253
e2f0360
fbf5eae
151f859
042440f
c229cd5
01ddf78
4d5cee9
53a031d
8e33ca4
08a41ce
0d3012e
ab422d7
4af93c8
ec4e3d6
bf4b294
d5f37df
fb35cec
5648a9b
9385746
470e0d9
f73364d
7d73ebe
cb41f92
8af28d1
2544d26
0785c0f
ee4232a
803d872
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
// Copyright (C) 2015-2025 The Neo Project. | ||
// | ||
// NotaryAssisted.cs file belongs to the neo project and is free | ||
// software distributed under the MIT software license, see the | ||
// accompanying file LICENSE in the main directory of the | ||
// repository or http://www.opensource.org/licenses/mit-license.php | ||
// for more details. | ||
// | ||
// Redistribution and use in source and binary forms with or without | ||
// modifications are permitted. | ||
|
||
using Neo.IO; | ||
using Neo.Json; | ||
using Neo.Persistence; | ||
using Neo.SmartContract.Native; | ||
using System.IO; | ||
using System.Linq; | ||
|
||
namespace Neo.Network.P2P.Payloads | ||
{ | ||
public class NotaryAssisted : TransactionAttribute | ||
{ | ||
/// <summary> | ||
/// Native Notary contract hash stub used until native Notary contract is properly implemented. | ||
/// </summary> | ||
private static readonly UInt160 notaryHash = Neo.SmartContract.Helper.GetContractHash(UInt160.Zero, 0, "Notary"); | ||
|
||
/// <summary> | ||
/// Indicates the number of keys participating in the transaction (main or fallback) signing process. | ||
/// </summary> | ||
public byte NKeys; | ||
|
||
public override TransactionAttributeType Type => TransactionAttributeType.NotaryAssisted; | ||
|
||
public override bool AllowMultiple => false; | ||
|
||
public override int Size => base.Size + sizeof(byte); | ||
|
||
protected override void DeserializeWithoutType(ref MemoryReader reader) | ||
{ | ||
NKeys = reader.ReadByte(); | ||
} | ||
|
||
protected override void SerializeWithoutType(BinaryWriter writer) | ||
{ | ||
writer.Write(NKeys); | ||
} | ||
|
||
public override JObject ToJson() | ||
{ | ||
JObject json = base.ToJson(); | ||
json["nkeys"] = NKeys; | ||
return json; | ||
} | ||
|
||
public override bool Verify(DataCache snapshot, Transaction tx) | ||
{ | ||
return tx.Signers.Any(p => p.Account.Equals(notaryHash)); | ||
} | ||
|
||
/// <summary> | ||
/// Calculates the network fee needed to pay for NotaryAssisted attribute. According to the | ||
/// https://github.com/neo-project/neo/issues/1573#issuecomment-704874472, network fee consists of | ||
/// the base Notary service fee per key multiplied by the expected number of transactions that should | ||
/// be collected by the service to complete Notary request increased by one (for Notary node witness | ||
/// itself). | ||
/// </summary> | ||
/// <param name="snapshot">The snapshot used to read data.</param> | ||
/// <param name="tx">The transaction to calculate.</param> | ||
/// <returns>The network fee of the NotaryAssisted attribute.</returns> | ||
public override long CalculateNetworkFee(DataCache snapshot, Transaction tx) | ||
{ | ||
return (NKeys + 1) * base.CalculateNetworkFee(snapshot, tx); | ||
} | ||
} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -43,6 +43,14 @@ internal override async ContractTask OnPersistAsync(ApplicationEngine engine) | |
{ | ||
await Burn(engine, tx.Sender, tx.SystemFee + tx.NetworkFee); | ||
totalNetworkFee += tx.NetworkFee; | ||
|
||
// Reward for NotaryAssisted attribute will be minted to designated notary nodes | ||
// by Notary contract. | ||
var notaryAssisted = tx.GetAttribute<NotaryAssisted>(); | ||
if (notaryAssisted is not null) | ||
{ | ||
totalNetworkFee -= (notaryAssisted.NKeys + 1) * Policy.GetAttributeFee(engine.SnapshotCache, (byte)notaryAssisted.Type); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @AnnaShaleva There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can't happen. It's OnPersist and it's executed before any in-block transaction, the value is the same as was used when verifying the transaction. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. BTW, it's pretty similar to There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @shargon, do you still have any concern about this issue? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm agree with @roman-khimov, it will be the same as other attributes, and other fees, but i'm not sure if this is the best way to recollect fees, why not deposit the Gas in the contract as a fee during the execution of the contract (like a regular contract can do)? |
||
} | ||
} | ||
ECPoint[] validators = NEO.GetNextBlockValidators(engine.SnapshotCache, engine.ProtocolSettings.ValidatorsCount); | ||
UInt160 primary = Contract.CreateSignatureRedeemScript(validators[engine.PersistingBlock.PrimaryIndex]).ToScriptHash(); | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
// Copyright (C) 2015-2025 The Neo Project. | ||
// | ||
// UT_NotaryAssisted.cs file belongs to the neo project and is free | ||
// software distributed under the MIT software license, see the | ||
// accompanying file LICENSE in the main directory of the | ||
// repository or http://www.opensource.org/licenses/mit-license.php | ||
// for more details. | ||
// | ||
// Redistribution and use in source and binary forms with or without | ||
// modifications are permitted. | ||
|
||
using FluentAssertions; | ||
using Microsoft.VisualStudio.TestTools.UnitTesting; | ||
using Neo.Extensions; | ||
using Neo.IO; | ||
using Neo.Network.P2P.Payloads; | ||
using Neo.SmartContract; | ||
using Neo.SmartContract.Native; | ||
using Neo.VM; | ||
using System; | ||
|
||
namespace Neo.UnitTests.Network.P2P.Payloads | ||
{ | ||
[TestClass] | ||
public class UT_NotaryAssisted | ||
{ | ||
// Use the hard-coded Notary hash value from NeoGo to ensure hashes are compatible. | ||
private static readonly UInt160 notaryHash = UInt160.Parse("0xc1e14f19c3e60d0b9244d06dd7ba9b113135ec3b"); | ||
|
||
[TestMethod] | ||
public void Size_Get() | ||
{ | ||
var attr = new NotaryAssisted() { NKeys = 4 }; | ||
attr.Size.Should().Be(1 + 1); | ||
} | ||
|
||
[TestMethod] | ||
public void ToJson() | ||
{ | ||
var attr = new NotaryAssisted() { NKeys = 4 }; | ||
var json = attr.ToJson().ToString(); | ||
Assert.AreEqual(@"{""type"":""NotaryAssisted"",""nkeys"":4}", json); | ||
} | ||
|
||
[TestMethod] | ||
public void DeserializeAndSerialize() | ||
{ | ||
var attr = new NotaryAssisted() { NKeys = 4 }; | ||
|
||
var clone = attr.ToArray().AsSerializable<NotaryAssisted>(); | ||
Assert.AreEqual(clone.Type, attr.Type); | ||
|
||
// As transactionAttribute | ||
byte[] buffer = attr.ToArray(); | ||
var reader = new MemoryReader(buffer); | ||
clone = TransactionAttribute.DeserializeFrom(ref reader) as NotaryAssisted; | ||
Assert.AreEqual(clone.Type, attr.Type); | ||
|
||
// Wrong type | ||
buffer[0] = 0xff; | ||
Assert.ThrowsExactly<FormatException>(() => | ||
{ | ||
var reader = new MemoryReader(buffer); | ||
TransactionAttribute.DeserializeFrom(ref reader); | ||
}); | ||
} | ||
|
||
[TestMethod] | ||
public void Verify() | ||
{ | ||
var attr = new NotaryAssisted() { NKeys = 4 }; | ||
|
||
// Temporary use Notary contract hash stub for valid transaction. | ||
var txGood = new Transaction { Signers = new Signer[] { new Signer() { Account = notaryHash } } }; | ||
var txBad = new Transaction { Signers = new Signer[] { new Signer() { Account = UInt160.Parse("0xa400ff00ff00ff00ff00ff00ff00ff00ff00ff01") } } }; | ||
var snapshot = TestBlockchain.GetTestSnapshotCache(); | ||
|
||
Assert.IsTrue(attr.Verify(snapshot, txGood)); | ||
Assert.IsFalse(attr.Verify(snapshot, txBad)); | ||
} | ||
|
||
[TestMethod] | ||
public void CalculateNetworkFee() | ||
{ | ||
var snapshot = TestBlockchain.GetTestSnapshotCache(); | ||
var attr = new NotaryAssisted() { NKeys = 4 }; | ||
var tx = new Transaction { Signers = new Signer[] { new Signer() { Account = notaryHash } } }; | ||
|
||
Assert.AreEqual((4 + 1) * 1000_0000, attr.CalculateNetworkFee(snapshot, tx)); | ||
} | ||
} | ||
} |
Uh oh!
There was an error while loading. Please reload this page.