Pull in observable API from UI #175

jacogr · 2018-09-28T17:36:11Z

Related #161

jacogr · 2018-09-30T12:40:00Z

Ok, pretty happy (?) with where it as a phase I. I had to limit the intent a bit and stuck with the existing naming instead of (as a first try), renaming everything along the way as well. So it basically just imports the new names and types.

As it stands, going to just use it as-is in the UI and see what pops up. Once working as expected, can marge and actually use the package. (Just from a speed of use perspective, sticking with the in-UI updated version with these large number of changes is a bit more prudent)

So as a first merge, the usable important bits are actually the small changes to codec - the api-observable is not quite intended for use yet, nor it is really mean to be.

jacogr · 2018-09-30T13:19:27Z

packages/api-codec/src/Metadata.ts

@@ -285,9 +287,9 @@ export default class RuntimeMetadata extends Struct {

  // We receive this as an Array<number> in the JSON output from the Node. Convert
  // to u8a and use the fromU8a to do the actual parsing
-  fromJSON (input: Array<number>): RuntimeMetadata {
+  fromJSON (input: Uint8Array | string | Array<number>): RuntimeMetadata {


The actual JSON has changed, it now comes in not as an Array<number>, but rather as a hex string. Cater for all.

jacogr · 2018-09-30T13:19:52Z

packages/api-codec/src/codec/Struct.ts

@@ -82,6 +84,10 @@ export default class Struct <
  }

  fromJSON (input: any): Struct<S, T, V, E> {
+    if (isHex(input)) {


Allows hex inputs, which gets treated as u8a

jacogr · 2018-09-30T13:20:30Z

packages/api-codec/src/codec/UInt.ts

+
+  // helpers from BN, this would be great as a "don't do this", i.e. extending properly
+  // from BN. Underlying these will always return BN (unless it is compare checks)
+  add (other: UInt | BN | number): BN {


Some helpers as a stop-gap, see comment of the Base interface PR.

jacogr · 2018-09-30T13:44:03Z

packages/api-codec/src/codec/Compact.ts

+//     nn nn nn 11 [ / zz zz zz zz ]{4 + n}
+//
+// Note: we use *LOW BITS* of the LSB in LE encoding to encode the 2 bit key.
+export default class Compact {


We pulled this encoding (basically just the encode/decode functions) from Length - parity-codec is looking to use this for all numbers, so make it share-able as "utility" functions. (Naming for the encoding now also aligns with what we have in parity-codec)

jacogr · 2018-09-30T13:46:04Z

packages/api-codec/src/codec/Length.ts

-  constructor (value: AnyNumber = new BN(0)) {
+  private _bitLength: BitLength;
+
+  constructor (value: AnyNumber = new BN(0), bitLength: BitLength = 32) {


Bit out of scope for this PR, so not changing things here... but since we have pulled the encoding logic into Compact, we would actually get rid of this use - rather, just call Compact.encode() with the length directly in the variable length uses instead of replying on Length. (Which as per the FIXME has always been a bit of a funny step-child)

jacogr · 2018-10-01T07:45:42Z

packages/api-observable/src/Base.ts

+const defaultMapFn = (result: any): any =>
+  result;
+
+export default class ApiBase {


Split out the implementation from the UI -

Base - just the basics, i.e. a nice wrapper for raw calls and storage

Calls - Anything that maps to an actual call on the API, i.e. getBlock

Queries - Anything that just simply wraps a storage query

Combined - Multiple observables combined into a single result

jacogr · 2018-10-01T07:47:32Z

packages/api-observable/src/Queries.ts

+      );
+  }
+
+  stakingFreeBalanceOf = (address: AccountId | string): Observable<Balance | undefined> => {


These need to be renamed - kept it as-is for the initial PR, i.e. just takin what is there and moving it to the correct storage area. (Actually started off renaming all, but in reality would first need to get the UI working and then start renaming)

Ok, makes sense.

Edit: was wrt your previous comment about not renaming for now.

amaury1093

Since this is the most user-facing library we'll have, comments are imo mandatory on all methods. But can be left for a later PR, when everything is more settled down.

amaury1093 · 2018-10-01T08:46:54Z

packages/api-observable/src/Queries.ts

+        [storage.balances.transactionByteFee],
+        [storage.balances.creationFee],
+        [storage.balances.existentialDeposit],
+        [storage.balances.transferFee ]


extra whitespace

amaury1093 · 2018-10-01T08:49:33Z

packages/api-observable/src/Queries.ts

+      );
+  }
+
+  stakingFreeBalanceOf = (address: AccountId | string): Observable<Balance | undefined> => {


Ok, makes sense.

Edit: was wrt your previous comment about not renaming for now.

amaury1093 · 2018-10-01T08:59:22Z

packages/api-observable/src/classes.ts

+// of the ISC license. See the LICENSE file for details.
+
+import BN from 'bn.js';
+import { AccountId, Balance, BlockNumber, PropIndex, Proposal, ReferendumIndex, VoteThreshold } from '@polkadot/api-codec/index';


Why is /index needed here? I guess for end-users it's also needed?

Habit. In the UI (I think) the tsconfig path mapping is a bit wonky with some packages. (Just the regex not being quite as good as it should be). Here it is actually not needed. (Looking at tsconfig, quite simple here). For end-users it is never required.

Nope, just checked, it still is needed - I think it is a tsconfig regex change, i.e. changing it to @polkadot/api-codec and it complains.

jacogr · 2018-10-01T09:14:30Z

100% with you on the documentation - and something else sorely missing here is the testing. (But first get it working and named properly.)

polkadot-js-bot · 2021-06-08T18:13:31Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

Pull in observable api...

8843ccf

jacogr added the WIP Work in Progress label Sep 28, 2018

jacogr added 9 commits September 28, 2018 20:05

Progress changing stuff...

f12efd3

votingBalance

f62d8ea

Update resul types

3252801

Expose toBn on Moment

ce71364

Rework... WIP

c841322

... More type cleanups

e992c88

Linting passes

d651c28

BN helpers for UInt

3f6398c

Update api-observable

8fb88d6

jacogr removed the WIP Work in Progress label Sep 30, 2018

jacogr added 2 commits September 30, 2018 14:44

Add api-observable package.json

08687f1

Allow Struct/Tuple to create from hex string

c47ff0d

jacogr commented Sep 30, 2018

View reviewed changes

jacogr added 2 commits September 30, 2018 15:35

Future-proof Length with bitLength (u64/u128 compant encoding PR out)

ba7cc26

Make Compact number encoding shareable

edc5f6b

jacogr commented Sep 30, 2018

View reviewed changes

jacogr added 2 commits October 1, 2018 09:38

Split Api into functional sections

e5d38af

Cleanup types

cb0f082

jacogr commented Oct 1, 2018

View reviewed changes

jacogr added 3 commits October 1, 2018 10:16

Additional per-use comments

1109f0f

Merge branch 'master' into jg-api-observable

69c18f3

Remove params/primitives from README

f6d60b4

amaury1093 reviewed Oct 1, 2018

View reviewed changes

jacogr added 2 commits October 1, 2018 11:06

api-format -> api-codec

0946f9b

Whitespace.

999994a

amaury1093 approved these changes Oct 1, 2018

View reviewed changes

jacogr merged commit 782bb80 into master Oct 1, 2018

jacogr deleted the jg-api-observable branch October 1, 2018 09:22

polkadot-js locked as resolved and limited conversation to collaborators Jun 8, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Pull in observable API from UI #175

Pull in observable API from UI #175

jacogr commented Sep 28, 2018

jacogr commented Sep 30, 2018 •

edited

jacogr Sep 30, 2018

jacogr Sep 30, 2018

jacogr Sep 30, 2018

jacogr Sep 30, 2018

jacogr Sep 30, 2018

jacogr Oct 1, 2018

jacogr Oct 1, 2018

amaury1093 Oct 1, 2018 •

edited

amaury1093 left a comment

amaury1093 Oct 1, 2018

amaury1093 Oct 1, 2018 •

edited

amaury1093 Oct 1, 2018

jacogr Oct 1, 2018

jacogr Oct 1, 2018

jacogr commented Oct 1, 2018

polkadot-js-bot commented Jun 8, 2021

Pull in observable API from UI #175

Pull in observable API from UI #175

Conversation

jacogr commented Sep 28, 2018

jacogr commented Sep 30, 2018 • edited

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

amaury1093 Oct 1, 2018 • edited

Choose a reason for hiding this comment

amaury1093 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

amaury1093 Oct 1, 2018 • edited

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

jacogr commented Oct 1, 2018

polkadot-js-bot commented Jun 8, 2021

jacogr commented Sep 30, 2018 •

edited

amaury1093 Oct 1, 2018 •

edited

amaury1093 Oct 1, 2018 •

edited