5f659ee2e02d6c30f404a3b2229406c368643e85-PR-1445

Build # 5f659ee2e02d6c30f404a3b2229406c368643e85-PR-1445

Build Type

github

Committed by GitHub

Commit Message

<a href="https://github.com/neo-project/neo/commit/<a class=hub.com/neo-project/neo/commit/<a class="double-link" href="https://git"><a class=hub.com/neo-project/neo/commit/<a class="double-link" href="https://git"><a class=hub.com/neo-project/neo/commit/<a class="double-link" href="https://git"><a class=hub.com/neo-project/neo/commit/<a class="double-link" href="https://git"><a class=hub.com/neo-project/neo/commit/5f659ee2e02d6c30f404a3b2229406c368643e85">5f659ee2e">&lt;a href=&quot;https://github.com/neo-project/neo/commit/</a><a class="double-link" href="https://github.com/neo-project/neo/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/neo-project/neo/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/neo-project/neo/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/neo-project/neo/commit/5f659ee2e02d6c30f404a3b2229406c368643e85">5f659ee2e</a><a href="https://github.com/neo-project/neo/commit/5f659ee2e02d6c30f404a3b2229406c368643e85">&lt;a href=&quot;https://github.com/neo-project/neo/commit/5f659ee2e02d6c30f404a3b2229406c368643e85&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/neo-project/neo/commit/&amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/neo-project/neo/commit/&amp;amp;lt;a class=&amp;amp;quot;double-link&amp;amp;quot; href=&amp;amp;quot;https://git&amp;quot;&amp;gt;&amp;amp;lt;a class=&amp;lt;/a&amp;gt;hub.com/neo-project/neo/commit/5f659ee2e02d6c30f404a3b2229406c368643e85&amp;quot;&amp;gt;5f659ee2e&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/neo-project/neo/commit/5f659ee2e02d6c30f404a3b2229406c368643e85&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/neo-project/neo/commit/5f659ee2e02d6c30f404a3b2229406c3&amp;lt;/a&amp;gt;686</a>43e85&quot;&gt;&amp;quot;&amp;gt;Merge &amp;lt;/a&amp;gt;&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/neo-project/neo/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://github.com/neo-project/neo/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/neo-project/neo/commit/8b118c081&quot;&gt;8b118c081&lt;/a&gt;&lt;a href=&quot;htt... (continued)

Pull Request Pull Request #1445: Oracle policy contract

Run Details

2942 of 4374 branches covered (67.26%)

Branch coverage included in aggregate %.

95 of 95 new or added lines in 2 files covered. (100.0%)

9862 of 12472 relevant lines covered (79.07%)

124171.52 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

53.45

/src/neo/SmartContract/Native/Oracle/OraclePolicyContract.cs

using Neo.Cryptography.ECC;
using Neo.IO;
using Neo.Ledger;
using Neo.Persistence;
using Neo.SmartContract;
using Neo.SmartContract.Manifest;
using Neo.SmartContract.Native;
using Neo.VM;
using Neo.VM.Types;
using System;
using System.Linq;
using System.Numerics;
using Array = Neo.VM.Types.Array;

namespace Neo.Oracle
{
    public sealed class OraclePolicyContract : NativeContract
    {
        public override string ServiceName => "Neo.Native.Oracle.Policy";

        public override int Id => -4;

        private const byte Prefix_Validator = 24;
        private const byte Prefix_TimeOutMilliSeconds = 25;
        private const byte Prefix_PerRequestFee = 26;

        /// <summary>
        /// Constructor
        /// </summary>
        public OraclePolicyContract()
        {
            Manifest.Features = ContractFeatures.HasStorage;
        }

        /// <summary>
        /// Initialization.Set default parameter value.
        /// </summary>
        /// <param name="engine">VM</param>
        /// <returns>Returns true if the execution is successful, otherwise returns false</returns>
        internal override bool Initialize(ApplicationEngine engine)
        {
            if (!base.Initialize(engine)) return false;
            engine.Snapshot.Storages.Add(CreateStorageKey(Prefix_TimeOutMilliSeconds), new StorageItem
            {
                Value = BitConverter.GetBytes(5000)
            });
            engine.Snapshot.Storages.Add(CreateStorageKey(Prefix_PerRequestFee), new StorageItem
            {
                Value = BitConverter.GetBytes(1000)
            });
            return true;
        }

        /// <summary>
        /// Oracle validator can delegate third party to operate Oracle nodes
        /// </summary>
        /// <param name="engine">VM</param>
        /// <param name="args">Parameter Array</param>
        /// <returns>Returns true if the execution is successful, otherwise returns false</returns>
        [ContractMethod(0_03000000, ContractParameterType.Boolean, ParameterTypes = new[] { ContractParameterType.ByteArray, ContractParameterType.ByteArray }, ParameterNames = new[] { "consignorPubKey", "consigneePubKey" })]
        private StackItem DelegateOracleValidator(ApplicationEngine engine, Array args)
        {
            ECPoint consignorPubKey = args[0].GetSpan().AsSerializable<ECPoint>();
            ECPoint consigneePubKey = args[1].GetSpan().AsSerializable<ECPoint>();
            UInt160 account = Contract.CreateSignatureRedeemScript(consignorPubKey).ToScriptHash();
            if (!InteropService.Runtime.CheckWitnessInternal(engine, account)) return false;
            StoreView snapshot = engine.Snapshot;
            StorageKey key = CreateStorageKey(Prefix_Validator, consignorPubKey);
            if (snapshot.Storages.TryGet(key) != null)
            {
                StorageItem value = snapshot.Storages.GetAndChange(key);
                value.Value = consigneePubKey.ToArray();
            }
            else
            {
                snapshot.Storages.Add(key, new StorageItem
                {
                    Value = consigneePubKey.ToArray()
                });
            }
            return true;
        }

        /// <summary>
        /// Get current authorized Oracle validator.
        /// </summary>
        /// <param name="engine">VM</param>
        /// <param name="args">Parameter Array</param>
        /// <returns>Authorized Oracle validator</returns>
        [ContractMethod(0_01000000, ContractParameterType.Array)]
        private StackItem GetOracleValidators(ApplicationEngine engine, Array args)
        {
            return new Array(engine.ReferenceCounter, GetOracleValidators(engine.Snapshot).Select(p => (StackItem)p.ToArray()));
        }

        /// <summary>
        /// Get current authorized Oracle validator
        /// </summary>
        /// <param name="snapshot">snapshot</param>
        /// <returns>Authorized Oracle validator</returns>
        public ECPoint[] GetOracleValidators(StoreView snapshot)
        {
            ECPoint[] oraclePubKeys = PolicyContract.NEO.GetValidators(snapshot);
            for (int index = 0; index < oraclePubKeys.Length; index++)
            {
                var oraclePubKey = oraclePubKeys[index];
                StorageKey key = CreateStorageKey(Prefix_Validator, oraclePubKey);
                ECPoint delegatePubKey = snapshot.Storages.TryGet(key)?.Value.AsSerializable<ECPoint>();
                if (delegatePubKey != null) { oraclePubKeys[index] = delegatePubKey; }
            }
            return oraclePubKeys;
        }

        /// <summary>
        /// Get number of current authorized Oracle validator
        /// </summary>
        /// <param name="engine">VM</param>
        /// <param name="args">Parameter Array</param>
        /// <returns>The number of authorized Oracle validator</returns>
        [ContractMethod(0_01000000, ContractParameterType.Integer)]
        private StackItem GetOracleValidatorsCount(ApplicationEngine engine, Array args)
        {
            return GetOracleValidatorsCount(engine.Snapshot);
        }

        /// <summary>
        /// Get number of current authorized Oracle validator
        /// </summary>
        /// <param name="snapshot">snapshot</param>
        /// <returns>The number of authorized Oracle validator</returns>
        public BigInteger GetOracleValidatorsCount(StoreView snapshot)
        {
            return GetOracleValidators(snapshot).Length;
        }

        /// <summary>
        /// Create a Oracle multisignature address
        /// </summary>
        /// <param name="snapshot">snapshot</param>
        /// <returns>Oracle multisignature address</returns>
        public UInt160 GetOracleMultiSigAddress(StoreView snapshot)
        {
            ECPoint[] validators = GetOracleValidators(snapshot);
            return Contract.CreateMultiSigRedeemScript(validators.Length - (validators.Length - 1) / 3, validators).ToScriptHash();
        }

        /// <summary>
        /// Set timeout
        /// </summary>
        /// <param name="engine">VM</param>
        /// <param name="args">Parameter Array</param>
        /// <returns>Returns true if the execution is successful, otherwise returns false</returns>
        [ContractMethod(0_03000000, ContractParameterType.Boolean, ParameterTypes = new[] { ContractParameterType.Integer }, ParameterNames = new[] { "TimeOutMilliSeconds" })]
        private StackItem SetTimeOutMilliSeconds(ApplicationEngine engine, Array args)
        {
            StoreView snapshot = engine.Snapshot;
            UInt160 account = GetOracleMultiSigAddress(snapshot);
            if (!InteropService.Runtime.CheckWitnessInternal(engine, account)) return false;
            if (BitConverter.ToInt32(args[0].GetSpan()) <= 0) return false;
            int timeOutMilliSeconds = BitConverter.ToInt32(args[0].GetSpan());
            StorageItem storage = snapshot.Storages.GetAndChange(CreateStorageKey(Prefix_TimeOutMilliSeconds));
            storage.Value = BitConverter.GetBytes(timeOutMilliSeconds);
            return true;
        }

        /// <summary>
        /// Get timeout
        /// </summary>
        /// <param name="engine">VM</param>
        /// <returns>value</returns>
        [ContractMethod(0_01000000, ContractParameterType.Integer)]
        private StackItem GetTimeOutMilliSeconds(ApplicationEngine engine, Array args)
        {
            return new Integer(GetTimeOutMilliSeconds(engine.Snapshot));
        }

        /// <summary>
        /// Get timeout
        /// </summary>
        /// <param name="snapshot">snapshot</param>
        /// <returns>value</returns>
        public int GetTimeOutMilliSeconds(StoreView snapshot)
        {
            return BitConverter.ToInt32(snapshot.Storages[CreateStorageKey(Prefix_TimeOutMilliSeconds)].Value, 0);
        }

        /// <summary>
        /// Set PerRequestFee
        /// </summary>
        /// <param name="engine">VM</param>
        /// <param name="args">Parameter Array</param>
        /// <returns>Returns true if the execution is successful, otherwise returns false</returns>
        [ContractMethod(0_03000000, ContractParameterType.Boolean, ParameterTypes = new[] { ContractParameterType.Integer }, ParameterNames = new[] { "fee" })]
        private StackItem SetPerRequestFee(ApplicationEngine engine, Array args)
        {
            StoreView snapshot = engine.Snapshot;
            UInt160 account = GetOracleMultiSigAddress(snapshot);
            if (!InteropService.Runtime.CheckWitnessInternal(engine, account)) return false;
            if (BitConverter.ToInt32(args[0].GetSpan()) <= 0) return false;
            int perRequestFee = BitConverter.ToInt32(args[0].GetSpan());
            StorageItem storage = snapshot.Storages.GetAndChange(CreateStorageKey(Prefix_PerRequestFee));
            storage.Value = BitConverter.GetBytes(perRequestFee);
            return true;
        }

        /// <summary>
        /// Get PerRequestFee
        /// </summary>
        /// <param name="engine">VM</param>
        /// <param name="args">Parameter Array</param>
        /// <returns>Value</returns>
        [ContractMethod(0_01000000, ContractParameterType.Integer, SafeMethod = true)]
        private StackItem GetPerRequestFee(ApplicationEngine engine, Array args)
        {
            return new Integer(GetPerRequestFee(engine.Snapshot));
        }

        /// <summary>
        /// Get PerRequestFee
        /// </summary>
        /// <param name="snapshot">snapshot</param>
        /// <returns>Value</returns>
        public int GetPerRequestFee(StoreView snapshot)
        {
            return BitConverter.ToInt32(snapshot.Storages[CreateStorageKey(Prefix_PerRequestFee)].Value, 0);
        }
    }
}

1	using Neo.Cryptography.ECC;
2	using Neo.IO;
3	using Neo.Ledger;
4	using Neo.Persistence;
5	using Neo.SmartContract;
6	using Neo.SmartContract.Manifest;
7	using Neo.SmartContract.Native;
8	using Neo.VM;
9	using Neo.VM.Types;
10	using System;
11	using System.Linq;
12	using System.Numerics;
13	using Array = Neo.VM.Types.Array;
14
15	namespace Neo.Oracle
16	{
17	public sealed class OraclePolicyContract : NativeContract
18	{
19	public override string ServiceName => "Neo.Native.Oracle.Policy";	2✔
20
21	public override int Id => -4;	117✔
22
23	private const byte Prefix_Validator = 24;
24	private const byte Prefix_TimeOutMilliSeconds = 25;
25	private const byte Prefix_PerRequestFee = 26;
26
27	/// <summary>
28	/// Constructor
29	/// </summary>
30	public OraclePolicyContract()	1✔
31	{	1✔
32	Manifest.Features = ContractFeatures.HasStorage;	1✔
33	}	1✔
34
35	/// <summary>
36	/// Initialization.Set default parameter value.
37	/// </summary>
38	/// <param name="engine">VM</param>
39	/// <returns>Returns true if the execution is successful, otherwise returns false</returns>
40	internal override bool Initialize(ApplicationEngine engine)
41	{	7✔
42	if (!base.Initialize(engine)) return false;	×
43	engine.Snapshot.Storages.Add(CreateStorageKey(Prefix_TimeOutMilliSeconds), new StorageItem	7✔
44	{	7✔
45	Value = BitConverter.GetBytes(5000)	7✔
46	});	7✔
47	engine.Snapshot.Storages.Add(CreateStorageKey(Prefix_PerRequestFee), new StorageItem	7✔
48	{	7✔
49	Value = BitConverter.GetBytes(1000)	7✔
50	});	7✔
51	return true;	7✔
52	}	7✔
53
54	/// <summary>
55	/// Oracle validator can delegate third party to operate Oracle nodes
56	/// </summary>
57	/// <param name="engine">VM</param>
58	/// <param name="args">Parameter Array</param>
59	/// <returns>Returns true if the execution is successful, otherwise returns false</returns>
60	[ContractMethod(0_03000000, ContractParameterType.Boolean, ParameterTypes = new[] { ContractParameterType.ByteArray, ContractParameterType.ByteArray }, ParameterNames = new[] { "consignorPubKey", "consigneePubKey" })]
61	private StackItem DelegateOracleValidator(ApplicationEngine engine, Array args)
62	{	6✔
63	ECPoint consignorPubKey = args[0].GetSpan().AsSerializable<ECPoint>();	6✔
64	ECPoint consigneePubKey = args[1].GetSpan().AsSerializable<ECPoint>();	6✔
65	UInt160 account = Contract.CreateSignatureRedeemScript(consignorPubKey).ToScriptHash();	6✔
66	if (!InteropService.Runtime.CheckWitnessInternal(engine, account)) return false;	12!
67	StoreView snapshot = engine.Snapshot;	×
68	StorageKey key = CreateStorageKey(Prefix_Validator, consignorPubKey);	×
69	if (snapshot.Storages.TryGet(key) != null)	×
70	{	×
71	StorageItem value = snapshot.Storages.GetAndChange(key);	×
72	value.Value = consigneePubKey.ToArray();	×
73	}	×
74	else
75	{	×
76	snapshot.Storages.Add(key, new StorageItem	×
77	{	×
78	Value = consigneePubKey.ToArray()	×
79	});	×
80	}	×
81	return true;	×
82	}	6✔
83
84	/// <summary>
85	/// Get current authorized Oracle validator.
86	/// </summary>
87	/// <param name="engine">VM</param>
88	/// <param name="args">Parameter Array</param>
89	/// <returns>Authorized Oracle validator</returns>
90	[ContractMethod(0_01000000, ContractParameterType.Array)]
91	private StackItem GetOracleValidators(ApplicationEngine engine, Array args)
92	{	6✔
93	return new Array(engine.ReferenceCounter, GetOracleValidators(engine.Snapshot).Select(p => (StackItem)p.ToArray()));	48✔
94	}	6✔
95
96	/// <summary>
97	/// Get current authorized Oracle validator
98	/// </summary>
99	/// <param name="snapshot">snapshot</param>
100	/// <returns>Authorized Oracle validator</returns>
101	public ECPoint[] GetOracleValidators(StoreView snapshot)
102	{	12✔
103	ECPoint[] oraclePubKeys = PolicyContract.NEO.GetValidators(snapshot);	12✔
104	for (int index = 0; index < oraclePubKeys.Length; index++)	192✔
105	{	84✔
106	var oraclePubKey = oraclePubKeys[index];	84✔
107	StorageKey key = CreateStorageKey(Prefix_Validator, oraclePubKey);	84✔
108	ECPoint delegatePubKey = snapshot.Storages.TryGet(key)?.Value.AsSerializable<ECPoint>();	84!
109	if (delegatePubKey != null) { oraclePubKeys[index] = delegatePubKey; }	×
110	}	84✔
111	return oraclePubKeys;	12✔
112	}	12✔
113
114	/// <summary>
115	/// Get number of current authorized Oracle validator
116	/// </summary>
117	/// <param name="engine">VM</param>
118	/// <param name="args">Parameter Array</param>
119	/// <returns>The number of authorized Oracle validator</returns>
120	[ContractMethod(0_01000000, ContractParameterType.Integer)]
121	private StackItem GetOracleValidatorsCount(ApplicationEngine engine, Array args)
122	{	6✔
123	return GetOracleValidatorsCount(engine.Snapshot);	6✔
124	}	6✔
125
126	/// <summary>
127	/// Get number of current authorized Oracle validator
128	/// </summary>
129	/// <param name="snapshot">snapshot</param>
130	/// <returns>The number of authorized Oracle validator</returns>
131	public BigInteger GetOracleValidatorsCount(StoreView snapshot)
132	{	6✔
133	return GetOracleValidators(snapshot).Length;	6✔
134	}	6✔
135
136	/// <summary>
137	/// Create a Oracle multisignature address
138	/// </summary>
139	/// <param name="snapshot">snapshot</param>
140	/// <returns>Oracle multisignature address</returns>
141	public UInt160 GetOracleMultiSigAddress(StoreView snapshot)
142	{	×
143	ECPoint[] validators = GetOracleValidators(snapshot);	×
144	return Contract.CreateMultiSigRedeemScript(validators.Length - (validators.Length - 1) / 3, validators).ToScriptHash();	×
145	}	×
146
147	/// <summary>
148	/// Set timeout
149	/// </summary>
150	/// <param name="engine">VM</param>
151	/// <param name="args">Parameter Array</param>
152	/// <returns>Returns true if the execution is successful, otherwise returns false</returns>
153	[ContractMethod(0_03000000, ContractParameterType.Boolean, ParameterTypes = new[] { ContractParameterType.Integer }, ParameterNames = new[] { "TimeOutMilliSeconds" })]
154	private StackItem SetTimeOutMilliSeconds(ApplicationEngine engine, Array args)
155	{	×
156	StoreView snapshot = engine.Snapshot;	×
157	UInt160 account = GetOracleMultiSigAddress(snapshot);	×
158	if (!InteropService.Runtime.CheckWitnessInternal(engine, account)) return false;	×
159	if (BitConverter.ToInt32(args[0].GetSpan()) <= 0) return false;	×
160	int timeOutMilliSeconds = BitConverter.ToInt32(args[0].GetSpan());	×
161	StorageItem storage = snapshot.Storages.GetAndChange(CreateStorageKey(Prefix_TimeOutMilliSeconds));	×
162	storage.Value = BitConverter.GetBytes(timeOutMilliSeconds);	×
163	return true;	×
164	}	×
165
166	/// <summary>
167	/// Get timeout
168	/// </summary>
169	/// <param name="engine">VM</param>
170	/// <returns>value</returns>
171	[ContractMethod(0_01000000, ContractParameterType.Integer)]
172	private StackItem GetTimeOutMilliSeconds(ApplicationEngine engine, Array args)
173	{	6✔
174	return new Integer(GetTimeOutMilliSeconds(engine.Snapshot));	6✔
175	}	6✔
176
177	/// <summary>
178	/// Get timeout
179	/// </summary>
180	/// <param name="snapshot">snapshot</param>
181	/// <returns>value</returns>
182	public int GetTimeOutMilliSeconds(StoreView snapshot)
183	{	6✔
184	return BitConverter.ToInt32(snapshot.Storages[CreateStorageKey(Prefix_TimeOutMilliSeconds)].Value, 0);	6✔
185	}	6✔
186
187	/// <summary>
188	/// Set PerRequestFee
189	/// </summary>
190	/// <param name="engine">VM</param>
191	/// <param name="args">Parameter Array</param>
192	/// <returns>Returns true if the execution is successful, otherwise returns false</returns>
193	[ContractMethod(0_03000000, ContractParameterType.Boolean, ParameterTypes = new[] { ContractParameterType.Integer }, ParameterNames = new[] { "fee" })]
194	private StackItem SetPerRequestFee(ApplicationEngine engine, Array args)
195	{	×
196	StoreView snapshot = engine.Snapshot;	×
197	UInt160 account = GetOracleMultiSigAddress(snapshot);	×
198	if (!InteropService.Runtime.CheckWitnessInternal(engine, account)) return false;	×
199	if (BitConverter.ToInt32(args[0].GetSpan()) <= 0) return false;	×
200	int perRequestFee = BitConverter.ToInt32(args[0].GetSpan());	×
201	StorageItem storage = snapshot.Storages.GetAndChange(CreateStorageKey(Prefix_PerRequestFee));	×
202	storage.Value = BitConverter.GetBytes(perRequestFee);	×
203	return true;	×
204	}	×
205
206	/// <summary>
207	/// Get PerRequestFee
208	/// </summary>
209	/// <param name="engine">VM</param>
210	/// <param name="args">Parameter Array</param>
211	/// <returns>Value</returns>
212	[ContractMethod(0_01000000, ContractParameterType.Integer, SafeMethod = true)]
213	private StackItem GetPerRequestFee(ApplicationEngine engine, Array args)
214	{	6✔
215	return new Integer(GetPerRequestFee(engine.Snapshot));	6✔
216	}	6✔
217
218	/// <summary>
219	/// Get PerRequestFee
220	/// </summary>
221	/// <param name="snapshot">snapshot</param>
222	/// <returns>Value</returns>
223	public int GetPerRequestFee(StoreView snapshot)
224	{	6✔
225	return BitConverter.ToInt32(snapshot.Storages[CreateStorageKey(Prefix_PerRequestFee)].Value, 0);	6✔
226	}	6✔
227	}
228	}

neo-project / neo / 5f659ee2e02d6c30f404a3b2229406c368643e85-PR-1445

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous