Added ConfigService, support mutability of static xcm configs

moonbeam-foundation / xcm-sdk

The Moonbeam XCM SDK enables developers to easily transfer assets between chains, either between parachains or between a parachain and the relay chain, within the Polkadot/Kusama ecosystem. With the SDK, you don't need to worry about determining the multilocation of the origin or destination assets or which extrinsics are used on which networks to

https://moonbeam-foundation.github.io/xcm-sdk/latest/

MIT License

14 stars 9 forks source link

Added ConfigService, support mutability of static xcm configs #124

Closed nohaapav closed 1 year ago

nohaapav commented 1 year ago

Description

Introducing ConfigService / IConfigService to allow seamless custom xcm registry configuration, with default fallback to static, existing one. For details visit here

Checklist

[x] If this requires a documentation change, I have created a PR in moonbeam-docs repository.
[x] If this requires it, I have updated the Readme
[x] If necessary, I have updated the examples
[x] I have verified if I need to create/update unit tests
[x] I have verified if I need to create/update acceptance tests
[x] If necessary, I have run acceptance tests on this branch in CI

changeset-bot[bot] commented 1 year ago

🦋 Changeset detected

Latest commit: 8ec274785dd4c31500529ad71a393aebeebcdf40

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

| Name | Type | | ---------------------------- | ----- | | @moonbeam-network/xcm-config | Minor | | @moonbeam-network/xcm-sdk | Minor |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

nohaapav commented 1 year ago

@ekenigs Hi so PR has landed :)

I've created MutableConfigService that should cover basic user needs:

updateAssets(asset: Asset): void - Create new or update existing asset
updateChains(chain: AnyChain): void - Create new or update existing chain
updateChain(chain: AnyChain, chainDelta: Partial<AnyChain>): void - Update existing chain with delta
updateChainConfig(chainConfig: ChainConfig): void - Create new or update existing chain config
updateAssetConfig(chain: AnyChain, assetConfig: AssetConfig): void - Create new or update existing chain asset config

Current config builder utils were moved to ConfigService which acts as fallback/default for ConfigBuilder unless user specify otherwise.

ekenigs commented 1 year ago

@nohaapav Hey, thanks for the PR. I hope that I will have some time next week to review it.

nohaapav commented 1 year ago

@nohaapav Hey, thanks for the PR. I hope that I will have some time next week to review it.

No worries, i've published custom @org/xcm-sdk & @org/xcm-config packages so it's not a blocker for me :) ..

nohaapav commented 1 year ago

@nohaapav Hey, thanks for the PR. I hope that I will have some time next week to review it.

@ekenigs Just pls let me know if it make sense to get PR merged in reasonable time in general. I can just update custom fork with fixes, it consumes less of my time as well. I know u are busy, so am i so let's find win win scenario here :)

ekenigs commented 1 year ago

@nohaapav Hey, thanks for the PR. I hope that I will have some time next week to review it.

@ekenigs Just pls let me know if it make sense to get PR merged in reasonable time in general. I can just update custom fork with fixes, it consumes less of my time as well. I know u are busy, so am i so let's find win win scenario here :)

@nohaapav Unfortunately, your timing coincided with a particularly busy period for us, as we're in the final stages of a new project. Due to this, I might not be able to review your PR immediately, but I'll do my best to take a look at it by tomorrow.