Skip to content

Add api examples to monorepo #1155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mnaamani merged 15 commits into from
Aug 20, 2020
Merged

Add api examples to monorepo #1155

Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
d19c507
api-examples
mnaamani Aug 8, 2020
711be6e
apply prettier formatting
mnaamani Aug 8, 2020
4236c3a
formatting
mnaamani Aug 8, 2020
bfa0305
api-examples: transferTest script
mnaamani Aug 10, 2020
36d510b
Merge remote-tracking branch 'leszek/account-info-rename' into yarnlo…
mnaamani Aug 11, 2020
9dd1cab
polkadot-api types, correctly reigster Address and LookupSource to ma…
mnaamani Aug 12, 2020
ba05fb5
api-examples: some code cleanup
mnaamani Aug 12, 2020
7081f0f
move api-examples to utils/ folder
mnaamani Aug 12, 2020
16687b6
api-examples: fix path to augment-types
mnaamani Aug 12, 2020
c989f88
Merge branch 'iznik' into iznik-api-examples
mnaamani Aug 13, 2020
9e28c05
api-examples: linter fixes
mnaamani Aug 14, 2020
67f3baf
api-examples: fix export data directory script for new runtime
mnaamani Aug 17, 2020
4f08ea2
Merge branch 'iznik' into iznik-api-examples
mnaamani Aug 17, 2020
0e3362b
api-examples: manually construct type registry when not requiring api
mnaamani Aug 19, 2020
0c3770d
api-examples: use createType
mnaamani Aug 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 6 additions & 10 deletions utils/api-examples/src/tohex.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
import { ApiPromise, WsProvider } from '@polkadot/api'
import { CuratorApplicationId } from '@joystream/types/content-working-group'
import { BTreeSet } from '@polkadot/types'
import { BTreeSet, createType, TypeRegistry } from '@polkadot/types'
import { types } from '@joystream/types'

async function main() {
Copy link
Member Author

@mnaamani mnaamani Aug 17, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This script only needs to create some types and doesn't need to read state from chain, and therefore shouldn't require creating an api instance or connecting to a node. I this type of scenario, what is the proper way to create a type registry and register our types so we can construct them safely.

cc: @Lezek123

Copy link
Contributor

@Lezek123 Lezek123 Aug 18, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a function to do this in https://github.com/Joystream/joystream/pull/1176/files#diff-9e9b5c1632859d4c7bee5d17dd9f7c5c, it's not well-tested yet, but I think it should work fine. I can move this to another PR if needed.

Copy link
Member Author

@mnaamani mnaamani Aug 19, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I spotted this also in pioneer react-api:
https://github.com/Joystream/joystream/blob/iznik/pioneer/packages/react-api/src/typeRegistry.ts
https://github.com/Joystream/joystream/blob/iznik/pioneer/packages/react-api/src/Api.tsx#L179

So it looks "safe" and correct way.

const provider = new WsProvider('ws://127.0.0.1:9944')
const api = await ApiPromise.create({ provider, types })

const wgId = [1, 2]

// Is it not possible to create the registry without actually connecting to a node?
const set = new BTreeSet<CuratorApplicationId>(api.registry, CuratorApplicationId, [])
const registry = new TypeRegistry()
registry.register(types)

const set = new BTreeSet<CuratorApplicationId>(registry, CuratorApplicationId, [])

wgId.forEach((id) => {
set.add(new CuratorApplicationId(api.registry, id))
set.add(createType(registry, 'CuratorApplicationId', id))
Copy link
Contributor

@Lezek123 Lezek123 Aug 19, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found out we can actually use registry.createType() instead, which is probably a better approach (I'm going to change it in @joystream/types too)

Copy link
Member Author

@mnaamani mnaamani Aug 20, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah yes that is neater, and one less import :)

})

/*
Expand All @@ -27,8 +25,6 @@ async function main() {

console.log('copy/paste the output below to hire curator applicant(s) with WG IDs:', wgId)
console.log(set.toHex())

api.disconnect()
}

main()