Skip to content

Commit 0b1135c

Browse files
authored
fix(express_relay): Update naming on express relay interfaces (#1358)
* Update naming on express relay interfaces
1 parent 16cc46e commit 0b1135c

File tree

7 files changed

+24
-82
lines changed

7 files changed

+24
-82
lines changed

express_relay/sdk/solidity/IPERMulticall.sol renamed to express_relay/sdk/solidity/IExpressRelay.sol

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
// Copyright (C) 2024 Lavra Holdings Limited - All Rights Reserved
33
pragma solidity ^0.8.0;
44

5-
interface IPERMulticall {
5+
interface IExpressRelay {
66
// Check if the combination of protocol and permissionKey is allowed within this transaction.
7-
// This will return true if and only if it's being called while executing the auction winner call.
8-
// @param protocol The address of the protocol that is gating an action behind this permission
9-
// @param permissionKey The permission key that is being checked
7+
// This will return true if and only if it's being called while executing the auction winner(s) call.
8+
// @param protocolFeeReceiver The address of the protocol that is gating an action behind this permission
9+
// @param permissionId The id that represents the action being gated
1010
// @return permissioned True if the permission is allowed, false otherwise
1111
function isPermissioned(
12-
address protocol,
13-
bytes calldata permissionKey
12+
address protocolFeeReceiver,
13+
bytes calldata permissionId
1414
) external view returns (bool permissioned);
1515
}

express_relay/sdk/solidity/IPERFeeReceiver.sol renamed to express_relay/sdk/solidity/IExpressRelayFeeReceiver.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// Copyright (C) 2024 Lavra Holdings Limited - All Rights Reserved
33
pragma solidity ^0.8.0;
44

5-
interface IPERFeeReceiver {
5+
interface IExpressRelayFeeReceiver {
66
// Receive the proceeds of an auction.
77
// @param permissionKey The permission key where the auction was conducted on.
88
function receiveAuctionProceedings(
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Pyth Express Relay Solidity SDK
1+
# Express Relay Solidity SDK
22

33
## Install
44

@@ -7,7 +7,7 @@
77
If you are using Truffle or Hardhat, simply install the NPM package:
88

99
```bash
10-
npm install @pythnetwork/per-sdk-solidity
10+
npm install @pythnetwork/express-relay-sdk-solidity
1111
```
1212

1313
### Foundry
@@ -17,11 +17,11 @@ From the root directory of your project, run:
1717

1818
```bash
1919
npm init -y
20-
npm install @pythnetwork/per-sdk-solidity
20+
npm install @pythnetwork/express-relay-sdk-solidity
2121
```
2222

2323
Then add the following line to your `remappings.txt` file:
2424

2525
```text
26-
@pythnetwork/per-sdk-solidity/=node_modules/@pythnetwork/per-sdk-solidity
26+
@pythnetwork/express-relay-sdk-solidity/=node_modules/@pythnetwork/express-relay-sdk-solidity
2727
```

express_relay/sdk/solidity/abis/IPERMulticall.json renamed to express_relay/sdk/solidity/abis/IExpressRelay.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
"inputs": [
44
{
55
"internalType": "address",
6-
"name": "protocol",
6+
"name": "protocolFeeReceiver",
77
"type": "address"
88
},
99
{
1010
"internalType": "bytes",
11-
"name": "permissionKey",
11+
"name": "permissionId",
1212
"type": "bytes"
1313
}
1414
],
File renamed without changes.

express_relay/sdk/solidity/package.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"name": "@pythnetwork/per-sdk-solidity",
3-
"version": "0.1.0",
4-
"description": "Solidity SDK for interacting with Pyth express relay contracts",
2+
"name": "@pythnetwork/express-relay-sdk-solidity",
3+
"version": "0.2.0",
4+
"description": "Solidity SDK for interacting with Express Relay contracts",
55
"repository": {
66
"type": "git",
77
"url": "https://github.com/pyth-network/pyth-crosschain",
@@ -12,7 +12,7 @@
1212
},
1313
"scripts": {
1414
"format": "npx prettier --write .",
15-
"generate-abi": "npx generate-abis IPERMulticall IPERFeeReceiver",
15+
"generate-abi": "npx generate-abis IExpressRelay IExpressRelayFeeReceiver",
1616
"check-abi": "git diff --exit-code abis"
1717
},
1818
"keywords": [

package-lock.json

Lines changed: 7 additions & 65 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)