Allow address inspection via the API #2184

KtorZ · 2020-09-24T16:50:01Z

Issue Number

Overview

2daae7e
📍 implement new stateless endpoint for inspecting addresses
It takes any arbitrary string as input and tries to deserialize it into some address information if possible, otherwise it fails with a proper error.
76d13ba
📍 add unit and integration tests for the new 'inspectAddress' function & endpoint

Comments

paweljakubas · 2020-09-25T06:42:57Z

lib/core-integration/src/Test/Integration/Scenario/API/Shelley/Addresses.hs

+    it "ADDRESS_INSPECT_01 - Address inspect OK" $ \ctx -> do
+        let str = "Ae2tdPwUPEYz6ExfbWubiXPB6daUuhJxikMEb4eXRp5oKZBKZwrbJ2k7EZe"
+        r <- request @Aeson.Value ctx (Link.inspectAddress str) Default Empty
+        expectResponseCode @IO HTTP.status200 r


any chance to also verify the result of this call here?

Yes and no. It's technically possible of course. But I'll rather defer that to until we have a proper data-type for representing inspected data (as highlighted in a FIXME comment). But I'd rather introduce this data-type in cardano-addresses directly.

paweljakubas · 2020-09-25T06:44:27Z

lib/core/src/Cardano/Wallet/Api/Types.hs

+newtype ApiAddressInspectData = ApiAddressInspectData
+    { unApiAddressInspectData :: Text }
+    deriving (Eq, Generic, Show)
+    deriving newtype (IsString)


could you comment why this was needed and used? (especially if we have Show above)

It allows for using the OverloadedString extension in a transparent fashion for literal strings like we do for Text and ByteString. So, one can write:

let inspectData = "patate"

instead of having to:

let inspectData = ApiAddressInspectData "patate"

paweljakubas · 2020-09-25T06:52:56Z

lib/shelley/src/Cardano/Wallet/Shelley/Compatibility.hs

@@ -1004,6 +1010,35 @@ instance DecodeAddress 'Mainnet where
 instance DecodeAddress ('Testnet pm) where
    decodeAddress = _decodeAddress SL.Testnet

+decodeBytes :: Text -> Either TextDecodingError ByteString


we already have cardano-addresses dependency in this project https://github.com/input-output-hk/cardano-wallet/blob/master/stack.yaml#L48 and also have many bits present here waiting for reuse. Probably not in thi sPR but I am in favor of strong reuse of cardano-addresses primitives..

At some point yes, I agree. I started this PR with only cardano-addresses originally and I ended up reverting because errors were highly inconsistent between endpoints. So I prefer sticking to how it's done now (and also, locate the code doing it in the same place so it's either to change later).

paweljakubas · 2020-09-25T06:54:57Z

lib/shelley/src/Cardano/Wallet/Shelley/Compatibility.hs


      where
        toNetwork :: Byron.NetworkMagic -> SL.Network
        toNetwork = \case
            Byron.NetworkMainOrStage -> SL.Mainnet
            Byron.NetworkTestnet{}   -> SL.Testnet

+-- FIXME: 'cardano-addresses' currently gives us an opaque 'Value'. It'd be


yes, agree https://github.com/input-output-hk/cardano-addresses/blob/master/core/lib/Cardano/Address/Style/Shelley.hs#L497

paweljakubas · 2020-09-25T06:56:31Z

specifications/api/swagger.yaml

+          script_hash:
+            type: string
+            format: base16
+            minLength: 64


hmm, I think in 1.20.0 in cardano-node they use 28-byte hash for scripts, not 32-byte

Yes, but cardano-addresses still uses 32 bytes :( ... So we need to change it there, bump revision and update here. Which was on my plate today ^^

paweljakubas

LGTM! I do think we should reconsider better reuse of lean cardano-addresses library in the future

KtorZ · 2020-09-25T08:19:59Z

bors merge

2138: Save intermediate state when restoring the Byron chain in the stake pools worker r=hasufell a=hasufell This completely skips byron era for mainnet when syncing stake pools. I extracted the first shelley block by looking at a fully synced stake pool DB and selecting the lowest `block_height` from the `pool_production` table. For non-mainnet it will record the last byron block of a chunk from the node into the `byron_headers` table and read it out during `readPoolProductionCursor` if there are no stake pools and otherwise ignore it. Remarks: - the "genesis shelley header" is hardcoded, because the node currently does not have an endpoint to get this 2184: Allow address inspection via the API r=KtorZ a=KtorZ # Issue Number  #2180 # Overview  - 2daae7e 📍 **implement new stateless endpoint for inspecting addresses** It takes any arbitrary string as input and tries to deserialize it into some address information if possible, otherwise it fails with a proper error. - 76d13ba 📍 **add unit and integration tests for the new 'inspectAddress' function & endpoint** # Comments  ![Screenshot from 2020-09-24 18-52-44](https://user-images.githubusercontent.com/5680256/94175596-2b686480-fe97-11ea-8325-66fa41c5577e.png)  Co-authored-by: Julian Ospald <[email protected]> Co-authored-by: KtorZ <[email protected]>

iohk-bors · 2020-09-25T10:20:10Z

Build failed (retrying...):

buildkite/cardano-wallet

Timed out, but:

 STAKE_POOLS_JOIN_01 - Cannot join existent stakepool with wrong password FAILED [1]
    STAKE_POOLS_JOIN_01rewards - Can join a pool, earn rewards and collect them FAILED [2]
    STAKE_POOLS_JOIN_02 - Cannot join already joined stake pool FAILED [3]
    STAKE_POOLS_JOIN_03 - Cannot join a pool that has retired FAILED [4]

iohk-bors · 2020-09-25T13:00:16Z

Merge conflict.

It takes any arbitrary string as input and tries to deserialize it into some address information if possible, otherwise it fails with a proper error.

…& endpoint

KtorZ · 2020-09-25T13:04:14Z

bors r+

2184: Allow address inspection via the API r=KtorZ a=KtorZ # Issue Number  #2180 # Overview  - 2daae7e 📍 **implement new stateless endpoint for inspecting addresses** It takes any arbitrary string as input and tries to deserialize it into some address information if possible, otherwise it fails with a proper error. - 76d13ba 📍 **add unit and integration tests for the new 'inspectAddress' function & endpoint** # Comments  ![Screenshot from 2020-09-24 18-52-44](https://user-images.githubusercontent.com/5680256/94175596-2b686480-fe97-11ea-8325-66fa41c5577e.png)  Co-authored-by: KtorZ <[email protected]>

KtorZ · 2020-09-25T14:46:59Z

CI stuck on the mac-mini again. Moving forward with that one :(

KtorZ · 2020-09-25T14:48:37Z

bors r-

iohk-bors · 2020-09-25T14:48:39Z

Canceled.

KtorZ added the ADDING FEATURE Mark a PR as adding a new feature, for auto-generated CHANGELOG label Sep 24, 2020

KtorZ requested a review from paweljakubas September 24, 2020 16:50

KtorZ self-assigned this Sep 24, 2020

KtorZ force-pushed the KtorZ/2180/address-inspect-via-api branch 3 times, most recently from 74cf3b8 to 689bd2b Compare September 24, 2020 19:48

rvl approved these changes Sep 25, 2020

View reviewed changes

paweljakubas reviewed Sep 25, 2020

View reviewed changes

paweljakubas approved these changes Sep 25, 2020

View reviewed changes

KtorZ added 2 commits September 25, 2020 15:03

implement new stateless endpoint for inspecting addresses

191db67

It takes any arbitrary string as input and tries to deserialize it into some address information if possible, otherwise it fails with a proper error.

add unit and integration tests for the new 'inspectAddress' function …

49e5000

…& endpoint

KtorZ force-pushed the KtorZ/2180/address-inspect-via-api branch from 689bd2b to 49e5000 Compare September 25, 2020 13:04

KtorZ merged commit e324626 into master Sep 25, 2020

KtorZ deleted the KtorZ/2180/address-inspect-via-api branch September 25, 2020 14:47

KtorZ mentioned this pull request Sep 28, 2020

Provide a way to validate addresses via the API. #2180

Closed

Anviking mentioned this pull request Oct 2, 2020

Flaky test - STAKE_POOLS_LIST_01 - List stake pools #2196

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow address inspection via the API #2184

Allow address inspection via the API #2184

KtorZ commented Sep 24, 2020 •

edited

Loading

paweljakubas Sep 25, 2020

KtorZ Sep 25, 2020

paweljakubas Sep 25, 2020

KtorZ Sep 25, 2020

paweljakubas Sep 25, 2020

KtorZ Sep 25, 2020

paweljakubas Sep 25, 2020

paweljakubas Sep 25, 2020

KtorZ Sep 25, 2020

paweljakubas left a comment

KtorZ commented Sep 25, 2020

iohk-bors bot commented Sep 25, 2020 •

edited by Anviking

Loading

iohk-bors bot commented Sep 25, 2020

KtorZ commented Sep 25, 2020

KtorZ commented Sep 25, 2020

KtorZ commented Sep 25, 2020

iohk-bors bot commented Sep 25, 2020

Allow address inspection via the API #2184

Allow address inspection via the API #2184

Conversation

KtorZ commented Sep 24, 2020 • edited Loading

Issue Number

Overview

Comments

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paweljakubas left a comment

Choose a reason for hiding this comment

KtorZ commented Sep 25, 2020

iohk-bors bot commented Sep 25, 2020 • edited by Anviking Loading

iohk-bors bot commented Sep 25, 2020

KtorZ commented Sep 25, 2020

KtorZ commented Sep 25, 2020

KtorZ commented Sep 25, 2020

iohk-bors bot commented Sep 25, 2020

KtorZ commented Sep 24, 2020 •

edited

Loading

iohk-bors bot commented Sep 25, 2020 •

edited by Anviking

Loading