Releases: safe-global/safe-config-service
Releases · safe-global/safe-config-service
Safe Config Service 2.1.0
API Breaking Change
- The endpoint
/api/v1/chains
now returns a collection ofgasPrice
instead of a singlegasPrice
. This way, fallback oracle providers can be provided (fixed price included) (#210)
{
...
"gasPrice": [], // gasPrice is now a collection and not a single object
}
Other Changes
Safe Config Service 2.0.3
Safe Config Service 2.0.2
Safe Config Service 2.0.1
Safe Config Service 2.0.0 – L2 Chains Release
L2 Chains – initial release
- Introduction of the chains endpoint: it can be accessed via
GET /api/v1/chains
- This endpoint provides chain related metadata including native currency used by the chain and theme information that can be used by the clients
- This endpoint was already part of past releases but this is the first production ready release for this endpoint.
- A webhook was introduced so whenever a chain is created, updated or deleted, the corresponding CGW instance gets called to invalidate its Chain related cache (setting up this webhook is optional for running the config-service) (#180)
blockExplorerUri
was removed –blockExplorerUriTemplate
should be used instead (#185)
Safe Config Service 1.4.0
Changes to /chains endpoint (work in progress)
- RPC URIs are no longer represented by a single string/uri. Each RPC is now an object that specifies the authentication mechanism for that RPC (#172). The possible values are:
API_KEY_PATH
– if an API key should be added to the base path of the the RPC (rpcUri.value
)NO_AUTHENTICATION
– if not authentication is required to use this RPC URI (rpcUri.value
can be used as is)
GET /api/v1/chains/<chain_id>
{
...
"rpcUri": {
"authentication": <"API_KEY_PATH" | "NO_AUTHENTICATION">,
"value": <stringified-uri>,
}
}
-
A different RPC url can be set as an alternative to be used by safe-apps on a specific chain (#169) – it follows the same object structure as
rpcUri
and can be accessed viasafeAppsRpcUri
-
A new object for representing a block explorer was added. This new object has fields for
address
andtxHash
templates. These templates can then be used by the clients to correctly create the final block explorer url that targets either anaddress
ortxHash
(#176)
GET /v1/chains/<chain_id>/
{
...
blockExplorerUriTemplate: {
"address": <string>, // eg.: https://etherscan.io/address/{{address}}
"txHash": <string> // eg.: https://etherscan.io/tx/{{txHash}}
}
}
Other changes
Safe Config Service 1.3.0
Unique identifier for each Safe App
- An application
id
was added to eachsafe-app
. Thisid
uniquely identifies each Safe App (#135)
GET /api/v1/safe-apps/
[
...
{
"id": <integer>,
"url": <string>,
"name": <string>,
...
}
]
Changes to /chains endpoint (work in progress)
- Breaking change: url fields were renamed to uri (#160)
- Added Gas Price information – it can either be considered
fixed
(fixed gas price) or can be associated to anoracle
.
GET /api/v1/chains/
// if an oracle is provided
"gasPrice": {
"type": "oracle",
"uri": <string>,
"gasParameter": <string>, // optional
"gweiFactor": <string> // multiplier returned in order to reach the gwei unit
}
// if a fixed gas price is provided
"gasPrice": {
"type": "fixed",
"weiValue": "10000000000"
}
nativeCurrency
now includes its logo (uri) (#142)- The pagination limit was increased to
100
(#145) - ENS Registry Address was added to each chain (optional field) (#143)
- Colours are now restricted to
#RRGGBB
format (#134) - A
recommendedMasterCopyVersion
was added – it represents the recommended deployed Safe master copy that should be used for each chain. (#153, #155)
Safe Config Service 1.2.0
New Features
- Safe Apps now have a unique id (integer) that's returned via
GET api/v1/safe-apps/
(#128) – thisid
uniquely represents one Safe App. This avoids issues where different URLs would point to the same resource/app. - Safe Apps now have a
visibility
modifier which can be set via the admin interface. This allows to easily show/hide a given application without having to delete its data (#130)
Changes to /chains
endpoint (work in progress)
gasPriceOracle
is now returned (#120) for each chain
{
...
"gasPriceOracle": { // optional
"url": <url-string>,
"gasParameter": <string> // eg.: safeLow | average | fast
}
}
Chains
can now be sorted by the internal fieldrelevance
– it's represented by an integer. Lower integers are given priority (ie.: show up first in the list) (#124)
Safe Config Service 1.1.0
Bug Fixes
- Enable blank values for safe-app provider (#115)
- Remove route slicing from logger (#111)
- Add trailing slash to
chains/id/
endpoint (#110)
New Features
- New endpoint
api/v1/about
– this endpoint gives basic information about the service. Currently it displays the name of the service, version of the service, api version of the request and if the request was done viahttps
orhttp
Changes to /chains
endpoint (work in progress)
/chains
now returns the theme information of the chain that can be used by the clients (#112):
"theme": {
"textColor": <hex-color-string>,
"backgroundColor": <hex-color-string>
}
- The public transaction service url was added to the
/chains
payload. This can be used by the clients in order to directly interact with the transaction service of a given chain (#106)
{
...
"transactionService": <url>
}
Safe Config Service 1.0.0
- Initial release
- Add /safe-apps endpoint which lists the endpoints
- Add /chains endpoint which lists the chains currently supported by the clients