3a3b79fff2fde676029219cd692af5409830ccfe-PR-1445

Build # 3a3b79fff2fde676029219cd692af5409830ccfe-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/3a3b79fff2fde676029219cd692af5409830ccfe">3a3b79fff<a href="https://github.com/neo-project/neo/commit/3a3b79fff2fde676029219cd692af5409830ccfe">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/neo-project/neo/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/neo-project/neo/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/neo-project/neo/commit/3a3b79fff2fde676029219cd692af5409830ccfe&quot;&gt;3a3b79fff&lt;/a&gt;&lt;a href=&quot;https://github.com/neo-project/neo/commit/3a3b79fff2fde676029219cd692af5409830ccfe&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/neo-project/neo/commit/3a3b79fff2fde676029219cd692af540&lt;/a&gt;9830ccfe">&quot;&gt;Merge &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/neo-project/neo/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/neo-project/neo/commit/<a class="double-link" href="https://github.com/neo-project/neo/commit/8698a5b7645603d176fffa086edce1aa210f2247">8698a5b76</a><a href="https://github.com/neo-project/neo/commit/3a3b79fff2fde676029219cd692af5409830ccfe">&amp;quot;&amp;gt;8698a5b76&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;8698a5b76&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/neo-project/neo/commit/3a3b79fff2fde676029219cd692af5409830c&lt;/a&gt;cfe&quot;&gt; into &lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/neo-project/neo/commit/<a class="double-link" href="https://github.com/neo-project/neo/commit/331e4857c">331e4857c">331e4857c</a>

Pull Request Pull Request #1445: Oracle policy contract

Run Details

2956 of 4382 branches covered (67.46%)

Branch coverage included in aggregate %.

112 of 112 new or added lines in 3 files covered. (100.0%)

9909 of 12489 relevant lines covered (79.34%)

123877.24 hits per line

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

86.92

/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.SmartContract.Native.Oracle;
using Neo.VM;
using Neo.VM.Types;
using System;
using System.Collections.Generic;
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_HttpConfig = 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_HttpConfig), new StorageItem
            {
                Value = new OracleHttpConfig() { Timeout = 5000 }.ToArray()
            });
            engine.Snapshot.Storages.Add(CreateStorageKey(Prefix_PerRequestFee), new StorageItem
            {
                Value = BitConverter.GetBytes(1000)
            });
            return true;
        }

        /// <summary>
        /// Consensus node 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)
        {
            StoreView snapshot = engine.Snapshot;
            ECPoint consignorPubKey = args[0].GetSpan().AsSerializable<ECPoint>();
            ECPoint consigneePubKey = args[1].GetSpan().AsSerializable<ECPoint>();
            ECPoint[] oraclePubKeys = PolicyContract.NEO.GetValidators(snapshot);
            if (!oraclePubKeys.Contains(consignorPubKey)) return false;
            UInt160 account = Contract.CreateSignatureRedeemScript(consignorPubKey).ToScriptHash();
            if (!InteropService.Runtime.CheckWitnessInternal(engine, account)) return false;
            StorageKey key = CreateStorageKey(Prefix_Validator, consignorPubKey);
            StorageItem item = snapshot.Storages.GetAndChange(key, () => new StorageItem());
            item.Value = consigneePubKey.ToArray();

            byte[] prefixKey = StorageKey.CreateSearchPrefix(Id, new[] { Prefix_Validator });
            List<ECPoint> delegatedOracleValidators = snapshot.Storages.Find(prefixKey).Select(p =>
              (
                  p.Key.Key.AsSerializable<ECPoint>(1)
              )).ToList();
            foreach (var validator in delegatedOracleValidators)
            {
                if (!oraclePubKeys.Contains(validator))
                {
                    snapshot.Storages.Delete(CreateStorageKey(Prefix_Validator, validator));
                }
            }
            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 HttpConfig
        /// </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[] { "httpConfig" })]
        private StackItem SetHttpConfig(ApplicationEngine engine, Array args)
        {
            StoreView snapshot = engine.Snapshot;
            UInt160 account = GetOracleMultiSigAddress(snapshot);
            if (!InteropService.Runtime.CheckWitnessInternal(engine, account)) return false;
            int timeOutMilliSeconds = (int)args[0].GetBigInteger();
            if (timeOutMilliSeconds <= 0) return false;
            OracleHttpConfig httpConfig = new OracleHttpConfig() { Timeout = timeOutMilliSeconds };
            StorageItem storage = snapshot.Storages.GetAndChange(CreateStorageKey(Prefix_HttpConfig));
            storage.Value = httpConfig.ToArray();
            return true;
        }

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

        /// <summary>
        /// Get HttpConfig
        /// </summary>
        /// <param name="snapshot">snapshot</param>
        /// <returns>value</returns>
        public OracleHttpConfig GetHttpConfig(StoreView snapshot)
        {
            return snapshot.Storages[CreateStorageKey(Prefix_HttpConfig)].Value.AsSerializable<OracleHttpConfig>();
        }

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

neo-project / neo / 3a3b79fff2fde676029219cd692af5409830ccfe-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