2c0b4cc35b6d4dad7dd706f7f0b71841bd07122c-PR-1445

Build # 2c0b4cc35b6d4dad7dd706f7f0b71841bd07122c-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/2c0b4cc35b6d4dad7dd706f7f0b71841bd07122c">2c0b4cc35<a href="https://github.com/neo-project/neo/commit/2c0b4cc35b6d4dad7dd706f7f0b71841bd07122c">&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/2c0b4cc35b6d4dad7dd706f7f0b71841bd07122c&quot;&gt;2c0b4cc35&lt;/a&gt;&lt;a href=&quot;https://github.com/neo-project/neo/commit/2c0b4cc35b6d4dad7dd706f7f0b71841bd07122c&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/neo-project/neo/commit/2c0b4cc35b6d4dad7dd706f7f0b71841&lt;/a&gt;bd07122c">&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/953a288e10474973f87a2689a000f5b80bcc9db7">953a288e1</a><a href="https://github.com/neo-project/neo/commit/2c0b4cc35b6d4dad7dd706f7f0b71841bd07122c">&amp;quot;&amp;gt;953a288e1&amp;lt;/a&amp;gt;&amp;quot;&amp;gt;953a288e1&amp;lt;/a&amp;gt;&amp;lt;a href=&amp;quot;https://github.com/neo-project/neo/commit/2c0b4cc35b6d4dad7dd706f7f0b71841bd071&lt;/a&gt;22c&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

2963 of 4382 branches covered (67.62%)

Branch coverage included in aggregate %.

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

9919 of 12491 relevant lines covered (79.41%)

124325.82 hits per line

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

98.48

/src/neo/SmartContract/Native/Oracle/OracleContract.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 OracleContract : 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;

        public OracleContract()
        {
            Manifest.Features = ContractFeatures.HasStorage;
        }

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

neo-project / neo / 2c0b4cc35b6d4dad7dd706f7f0b71841bd07122c-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