Skip to content

Commit 61651a1

Browse files
ali-behjatiali-behjati
authored
Modify PriceInfo struct for gas optimization (#373)
This PR removes unneeded PriceInfo fields and rearranges the struct in a way that it takes less storage.
1 parent 61b84c8 commit 61651a1

File tree

4 files changed

+137
-31
lines changed

4 files changed

+137
-31
lines changed

‎ethereum/contracts/pyth/Pyth.sol

Lines changed: 29 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,14 @@ abstract contract Pyth is PythGetters, PythSetters, AbstractPyth {
4141
PythInternalStructs.PriceInfo memory latestPrice = latestPriceInfo(attestation.priceId);
4242

4343
bool fresh = false;
44-
if(newPriceInfo.priceFeed.price.publishTime > latestPrice.priceFeed.price.publishTime) {
44+
if(newPriceInfo.price.publishTime > latestPrice.price.publishTime) {
4545
freshPrices += 1;
4646
fresh = true;
4747
setLatestPriceInfo(attestation.priceId, newPriceInfo);
4848
}
4949

50-
emit PriceFeedUpdate(attestation.priceId, fresh, vm.emitterChainId, vm.sequence, latestPrice.priceFeed.price.publishTime,
51-
newPriceInfo.priceFeed.price.publishTime, newPriceInfo.priceFeed.price.price, newPriceInfo.priceFeed.price.conf);
50+
emit PriceFeedUpdate(attestation.priceId, fresh, vm.emitterChainId, vm.sequence, latestPrice.price.publishTime,
51+
newPriceInfo.price.publishTime, newPriceInfo.price.price, newPriceInfo.price.conf);
5252
}
5353

5454
emit BatchPriceFeedUpdate(vm.emitterChainId, vm.sequence, batch.attestations.length, freshPrices);
@@ -76,32 +76,27 @@ abstract contract Pyth is PythGetters, PythSetters, AbstractPyth {
7676
return singleUpdateFeeInWei() * updateData.length;
7777
}
7878

79-
function createNewPriceInfo(PythInternalStructs.PriceAttestation memory pa) private view returns (PythInternalStructs.PriceInfo memory info) {
80-
info.attestationTime = pa.attestationTime;
81-
info.arrivalTime = block.timestamp;
82-
info.arrivalBlock = block.number;
83-
info.priceFeed.id = pa.priceId;
84-
79+
function createNewPriceInfo(PythInternalStructs.PriceAttestation memory pa) private pure returns (PythInternalStructs.PriceInfo memory info) {
8580
PythInternalStructs.PriceAttestationStatus status = PythInternalStructs.PriceAttestationStatus(pa.status);
8681
if (status == PythInternalStructs.PriceAttestationStatus.TRADING) {
87-
info.priceFeed.price.price = pa.price;
88-
info.priceFeed.price.conf = pa.conf;
89-
info.priceFeed.price.publishTime = pa.publishTime;
90-
info.priceFeed.emaPrice.publishTime = pa.publishTime;
82+
info.price.price = pa.price;
83+
info.price.conf = pa.conf;
84+
info.price.publishTime = pa.publishTime;
85+
info.emaPrice.publishTime = pa.publishTime;
9186
} else {
92-
info.priceFeed.price.price = pa.prevPrice;
93-
info.priceFeed.price.conf = pa.prevConf;
94-
info.priceFeed.price.publishTime = pa.prevPublishTime;
87+
info.price.price = pa.prevPrice;
88+
info.price.conf = pa.prevConf;
89+
info.price.publishTime = pa.prevPublishTime;
9590

9691
// The EMA is last updated when the aggregate had trading status,
9792
// so, we use prev_publish_time (the time when the aggregate last had trading status).
98-
info.priceFeed.emaPrice.publishTime = pa.prevPublishTime;
93+
info.emaPrice.publishTime = pa.prevPublishTime;
9994
}
10095

101-
info.priceFeed.price.expo = pa.expo;
102-
info.priceFeed.emaPrice.price = pa.emaPrice;
103-
info.priceFeed.emaPrice.conf = pa.emaConf;
104-
info.priceFeed.emaPrice.expo = pa.expo;
96+
info.price.expo = pa.expo;
97+
info.emaPrice.price = pa.emaPrice;
98+
info.emaPrice.conf = pa.emaConf;
99+
info.emaPrice.expo = pa.expo;
105100

106101
return info;
107102
}
@@ -226,14 +221,23 @@ abstract contract Pyth is PythGetters, PythSetters, AbstractPyth {
226221
function queryPriceFeed(bytes32 id) public view override returns (PythStructs.PriceFeed memory priceFeed){
227222
// Look up the latest price info for the given ID
228223
PythInternalStructs.PriceInfo memory info = latestPriceInfo(id);
229-
require(info.priceFeed.id != 0, "price feed for the given id is not pushed or does not exist");
230-
231-
return info.priceFeed;
224+
require(info.price.publishTime != 0, "price feed for the given id is not pushed or does not exist");
225+
226+
priceFeed.id = id;
227+
priceFeed.price.price = info.price.price;
228+
priceFeed.price.conf = info.price.conf;
229+
priceFeed.price.expo = info.price.expo;
230+
priceFeed.price.publishTime = uint(info.price.publishTime);
231+
232+
priceFeed.emaPrice.price = info.emaPrice.price;
233+
priceFeed.emaPrice.conf = info.emaPrice.conf;
234+
priceFeed.emaPrice.expo = info.emaPrice.expo;
235+
priceFeed.emaPrice.publishTime = uint(info.emaPrice.publishTime);
232236
}
233237

234238
function priceFeedExists(bytes32 id) public override view returns (bool) {
235239
PythInternalStructs.PriceInfo memory info = latestPriceInfo(id);
236-
return (info.priceFeed.id != 0);
240+
return (info.price.publishTime != 0);
237241
}
238242

239243
function getValidTimePeriod() public override view returns (uint) {

‎ethereum/contracts/pyth/PythDeprecatedStructs.sol

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
2+
// contracts/PythDeprecatedStructs.sol
3+
// SPDX-License-Identifier: Apache 2
4+
5+
pragma solidity ^0.8.0;
6+
7+
// This contract contains self contained structs of all our deprecated structs.
8+
// When deprecating the structs, make sure that there be no dependency to
9+
// the sdk as the sdk might change.
10+
//
11+
// By storing these structs, we keep deprecated fields definitions correctly. Then,
12+
// in the future, we can use them to cleanup their storage and redeem some gas back.
13+
contract PythDeprecatedStructs {
14+
// Structs related to the _deprecatedLatestPriceInfoV1
15+
enum DeprecatedPriceStatusV1 {
16+
UNKNOWN,
17+
TRADING,
18+
HALTED,
19+
AUCTION
20+
}
21+
22+
struct DeprecatedPriceFeedV1 {
23+
// The price ID.
24+
bytes32 id;
25+
// Product account key.
26+
bytes32 productId;
27+
// The current price.
28+
int64 price;
29+
// Confidence interval around the price.
30+
uint64 conf;
31+
// Price exponent.
32+
int32 expo;
33+
// Status of price.
34+
DeprecatedPriceStatusV1 status;
35+
// Maximum number of allowed publishers that can contribute to a price.
36+
uint32 maxNumPublishers;
37+
// Number of publishers that made up current aggregate.
38+
uint32 numPublishers;
39+
// Exponentially moving average price.
40+
int64 emaPrice;
41+
// Exponentially moving average confidence interval.
42+
uint64 emaConf;
43+
// Unix timestamp describing when the price was published
44+
uint64 publishTime;
45+
// Price of previous price with TRADING status
46+
int64 prevPrice;
47+
// Confidence interval of previous price with TRADING status
48+
uint64 prevConf;
49+
// Unix timestamp describing when the previous price with TRADING status was published
50+
uint64 prevPublishTime;
51+
}
52+
53+
struct DeprecatedPriceInfoV1 {
54+
uint256 attestationTime;
55+
uint256 arrivalTime;
56+
uint256 arrivalBlock;
57+
DeprecatedPriceFeedV1 priceFeed;
58+
}
59+
60+
// Structs related to the _deprecatedLatestPriceInfoV2
61+
struct DeprecatedPriceV2 {
62+
// Price
63+
int64 price;
64+
// Confidence interval around the price
65+
uint64 conf;
66+
// Price exponent
67+
int32 expo;
68+
// Unix timestamp describing when the price was published
69+
uint publishTime;
70+
}
71+
72+
// PriceFeed represents a current aggregate price from pyth publisher feeds.
73+
struct DeprecatedPriceFeedV2 {
74+
// The price ID.
75+
bytes32 id;
76+
// Latest available price
77+
DeprecatedPriceV2 price;
78+
// Latest available exponentially-weighted moving average price
79+
DeprecatedPriceV2 emaPrice;
80+
}
81+
82+
83+
struct DeprecatedPriceInfoV2 {
84+
uint256 attestationTime;
85+
uint256 arrivalTime;
86+
uint256 arrivalBlock;
87+
DeprecatedPriceFeedV2 priceFeed;
88+
}
89+
}

‎ethereum/contracts/pyth/PythInternalStructs.sol

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,11 +43,19 @@ contract PythInternalStructs {
4343
uint64 prevConf;
4444
}
4545

46+
struct InternalPrice {
47+
int64 price;
48+
uint64 conf;
49+
uint64 publishTime;
50+
int32 expo;
51+
}
52+
4653
struct PriceInfo {
47-
uint256 attestationTime;
48-
uint256 arrivalTime;
49-
uint256 arrivalBlock;
50-
PythStructs.PriceFeed priceFeed;
54+
// slot 1
55+
InternalPrice price;
56+
57+
// slot 2
58+
InternalPrice emaPrice;
5159
}
5260

5361
struct DataSource {

‎ethereum/contracts/pyth/PythState.sol

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
pragma solidity ^0.8.0;
55

66
import "./PythInternalStructs.sol";
7+
import "./PythDeprecatedStructs.sol";
78

89
contract PythStorage {
910
struct State {
@@ -12,7 +13,7 @@ contract PythStorage {
1213
bytes32 _deprecatedPyth2WormholeEmitter; // Ditto
1314

1415
// After a backward-incompatible change in PriceFeed this mapping got deprecated.
15-
mapping(bytes32 => PythInternalStructs.PriceInfo) _deprecatedLatestPriceInfo;
16+
mapping(bytes32 => PythDeprecatedStructs.DeprecatedPriceInfoV1) _deprecatedLatestPriceInfoV1;
1617

1718
// For tracking all active emitter/chain ID pairs
1819
PythInternalStructs.DataSource[] validDataSources;
@@ -38,11 +39,15 @@ contract PythStorage {
3839

3940
// Mapping of cached price information
4041
// priceId => PriceInfo
41-
mapping(bytes32 => PythInternalStructs.PriceInfo) latestPriceInfo;
42+
mapping(bytes32 => PythDeprecatedStructs.DeprecatedPriceInfoV2) _deprecatedLatestPriceInfoV2;
4243

4344
// Index of the governance data source, increased each time the governance data source
4445
// changes.
4546
uint32 governanceDataSourceIndex;
47+
48+
// Mapping of cached price information
49+
// priceId => PriceInfo
50+
mapping(bytes32 => PythInternalStructs.PriceInfo) latestPriceInfo;
4651
}
4752
}
4853

0 commit comments

Comments
 (0)