Skip to content
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

feat: allow for registry override #369

Merged
merged 10 commits into from
Feb 16, 2024
Merged

feat: allow for registry override #369

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
2b486c6
updated parseRegistry and tests
bee344 Feb 9, 2024
96098e7
linting
bee344 Feb 9, 2024
88de163
updated comments
bee344 Feb 9, 2024
a580b29
refactoring
bee344 Feb 9, 2024
bba7910
added error for new chain without tokens
bee344 Feb 9, 2024
0062c10
removed duplicate test case
bee344 Feb 12, 2024
30ea9d0
linting
bee344 Feb 12, 2024
2760df8
rename to overrideRegistry
bee344 Feb 13, 2024
7df5b14
updated README
bee344 Feb 13, 2024
ef37cd0
ran yarn docs
bee344 Feb 13, 2024
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
4 changes: 4 additions & 0 deletions src/errors/BaseError.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ export enum BaseErrorsEnum {
* The specName was not provided when injecting a new chain in the registry.
*/
SpecNameNotProvided = 'SpecNameNotProvided',
/**
* The tokens were not provided when injecting a new chain in the registry.
*/
TokensNotProvided = 'TokensNotProvided',
/**
* The direction in which these assets are going to be sent is incorrect.
*/
Expand Down
366 changes: 297 additions & 69 deletions src/registry/parseRegistry.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,20 @@ describe('parseRegistry', () => {

expect(err).toThrow('A specName must be provided when adding a new chain');
});
it('Should error when adding a new chain without tokens', () => {
const opts = {
injectedRegistry: {
rococo: {
'6666': {
specName: 'termo',
},
},
},
};
const err = () => parseRegistry(reg as ChainInfoRegistry<ChainInfoKeys>, opts);

expect(err).toThrow('An array of tokens must be provided when adding a new chain');
});
it('Should correctly add a new foreignAsset ignoring the specName', () => {
const specName = 'prorrata';
const foreignAssetsInfo = {
Expand Down Expand Up @@ -469,73 +483,287 @@ describe('parseRegistry', () => {
specName: 'termo',
});
});
});
it('Should correctly add a new xcAsset ignoring the existing one', () => {
const specName = 'prorrata';
const xcAssetsData = [
{
paraID: 1000,
symbol: 'RMRK',
decimals: 10,
xcmV1MultiLocation:
'{"v1":{"parents":1,"interior":{"x3":[{"parachain":1000},{"palletInstance":50},{"generalIndex":8}]}}}',
asset: {
Token: 'RMRK',
},
},
{
paraID: 1230,
symbol: 'USDT',
decimals: 7,
xcmV1MultiLocation:
'{"v1":{"parents":1,"interior":{"x3":[{"parachain":1000},{"palletInstance":50},{"generalIndex":1984}]}}}',
asset: {
Token2: '0',
},
},
];
const opts = {
injectedRegistry: {
rococo: {
'4000': {
specName,
xcAssetsData,
},
},
},
};
const registry = parseRegistry(reg as ChainInfoRegistry<ChainInfoKeys>, opts);

expect(registry.rococo['4000'].xcAssetsData).toStrictEqual([
{
paraID: 1000,
symbol: 'RMRK',
decimals: 10,
xcmV1MultiLocation:
'{"v1":{"parents":1,"interior":{"x3":[{"parachain":1000},{"palletInstance":50},{"generalIndex":8}]}}}',
asset: {
Token: 'RMRK',
},
},
{
paraID: 1000,
symbol: 'USDT',
decimals: 6,
xcmV1MultiLocation:
'{"v1":{"parents":1,"interior":{"x3":[{"parachain":1000},{"palletInstance":50},{"generalIndex":1984}]}}}',
asset: {
Token2: '0',
},
},
{
paraID: 1230,
symbol: 'USDT',
decimals: 7,
xcmV1MultiLocation:
'{"v1":{"parents":1,"interior":{"x3":[{"parachain":1000},{"palletInstance":50},{"generalIndex":1984}]}}}',
asset: {
Token2: '0',
},
},
]);

it('Should correctly add a new xcAsset ignoring the existing one', () => {
const specName = 'prorrata';
const xcAssetsData = [
{
paraID: 1000,
symbol: 'RMRK',
decimals: 10,
xcmV1MultiLocation:
'{"v1":{"parents":1,"interior":{"x3":[{"parachain":1000},{"palletInstance":50},{"generalIndex":8}]}}}',
asset: {
Token: 'RMRK',
},
},
{
paraID: 1230,
symbol: 'USDT',
decimals: 7,
xcmV1MultiLocation:
'{"v1":{"parents":1,"interior":{"x3":[{"parachain":1000},{"palletInstance":50},{"generalIndex":1984}]}}}',
asset: {
Token2: '0',
},
},
];
const opts = {
injectedRegistry: {
rococo: {
'4000': {
specName,
xcAssetsData,
},
},
},
};
const registry = parseRegistry(reg as ChainInfoRegistry<ChainInfoKeys>, opts);

expect(registry.rococo['4000'].xcAssetsData).toStrictEqual([
{
paraID: 1000,
symbol: 'RMRK',
decimals: 10,
xcmV1MultiLocation:
'{"v1":{"parents":1,"interior":{"x3":[{"parachain":1000},{"palletInstance":50},{"generalIndex":8}]}}}',
asset: {
Token: 'RMRK',
},
},
{
paraID: 1000,
symbol: 'USDT',
decimals: 6,
xcmV1MultiLocation:
'{"v1":{"parents":1,"interior":{"x3":[{"parachain":1000},{"palletInstance":50},{"generalIndex":1984}]}}}',
asset: {
Token2: '0',
},
},
{
paraID: 1230,
symbol: 'USDT',
decimals: 7,
xcmV1MultiLocation:
'{"v1":{"parents":1,"interior":{"x3":[{"parachain":1000},{"palletInstance":50},{"generalIndex":1984}]}}}',
asset: {
Token2: '0',
},
},
]);
});
it("Should correctly override the registry's token entry", () => {
const opts = {
overridingRegistry: {
westend: {
'0': {
tokens: ['WOP', 'WER'],
},
},
},
};
const registry = parseRegistry(reg as ChainInfoRegistry<ChainInfoKeys>, opts);

expect(registry.westend['0'].tokens).toStrictEqual(['WOP', 'WER']);
});
it("Should correctly override the registry's token entry", () => {
bee344 marked this conversation as resolved.
Show resolved Hide resolved
const opts = {
overridingRegistry: {
westend: {
'0': {
tokens: ['WOP', 'WER'],
},
},
},
};
const registry = parseRegistry(reg as ChainInfoRegistry<ChainInfoKeys>, opts);

expect(registry.westend['0'].tokens).toStrictEqual(['WOP', 'WER']);
});
it('Should correctly override xcAsset', () => {
const xcAssetsData = [
{
paraID: 1000,
symbol: 'RMRK',
decimals: 10,
xcmV1MultiLocation:
'{"v1":{"parents":1,"interior":{"x3":[{"parachain":1000},{"palletInstance":50},{"generalIndex":8}]}}}',
asset: {
Token: 'RMRK',
},
},
{
paraID: 1230,
symbol: 'USDT',
decimals: 7,
xcmV1MultiLocation:
'{"v1":{"parents":1,"interior":{"x3":[{"parachain":1000},{"palletInstance":50},{"generalIndex":1984}]}}}',
asset: {
Token2: '0',
},
},
];
const opts = {
overridingRegistry: {
rococo: {
'4000': {
xcAssetsData,
},
},
},
};
const registry = parseRegistry(reg as ChainInfoRegistry<ChainInfoKeys>, opts);

expect(registry.rococo['4000'].xcAssetsData).toEqual([
{
paraID: 1000,
symbol: 'RMRK',
decimals: 10,
xcmV1MultiLocation:
'{"v1":{"parents":1,"interior":{"x3":[{"parachain":1000},{"palletInstance":50},{"generalIndex":8}]}}}',
asset: {
Token: 'RMRK',
},
},
{
paraID: 1230,
symbol: 'USDT',
decimals: 7,
xcmV1MultiLocation:
'{"v1":{"parents":1,"interior":{"x3":[{"parachain":1000},{"palletInstance":50},{"generalIndex":1984}]}}}',
asset: {
Token2: '0',
},
},
]);
});
it('Should correctly override the existing entries in assetsInfo and tokens', () => {
const assetsInfo = {
'0': 'POTATO',
'1': 'L T',
'2': 'RANOVER',
'3': 'Meow',
'4': 'HAPPY',
'3611': 'MATE',
};
const tokens = ['RTK'];
const opts = {
overridingRegistry: {
kusama: {
'1000': {
tokens: tokens,
assetsInfo: assetsInfo,
},
},
},
};

const registry = parseRegistry(reg as ChainInfoRegistry<ChainInfoKeys>, opts);

expect(registry.kusama['1000'].assetsInfo['0']).toStrictEqual('POTATO');
expect(registry.kusama['1000'].assetsInfo['2511']).toStrictEqual('TESTY');
expect(registry.kusama['1000'].assetsInfo['3611']).toStrictEqual('MATE');
expect(registry.kusama['1000'].tokens).toStrictEqual(['RTK']);
});
it('Should correctly override existing entries for poolPairsInfo', () => {
const poolPairsInfo = {
'8': {
lpToken: '8',
pairInfo:
'[[{"parents":"0","interior":"Here"},{"parents":"1","interior":{"X2":[{"PalletInstance":"50"},{"GeneralIndex":"9999"}]}}]]',
},
};
const opts = {
overridingRegistry: {
westend: {
'4000': {
poolPairsInfo,
},
},
},
};

const registry = parseRegistry(reg as ChainInfoRegistry<ChainInfoKeys>, opts);

expect(registry.westend['4000'].poolPairsInfo['8']).toStrictEqual({
lpToken: '8',
pairInfo:
'[[{"parents":"0","interior":"Here"},{"parents":"1","interior":{"X2":[{"PalletInstance":"50"},{"GeneralIndex":"9999"}]}}]]',
});
});
it('Should correctly override existing entries for poolPairsInfo after an injectedRegistry', () => {
const poolPairsInfo = {
'8': {
lpToken: '8',
pairInfo:
'[[{"parents":"2","interior":"Here"},{"parents":"1","interior":{"X2":[{"PalletInstance":"50"},{"GeneralIndex":"25"}]}}]]',
},
'9': {
lpToken: '9',
pairInfo:
'[[{"parents":"0","interior":"Here"},{"parents":"1","interior":{"X2":[{"PalletInstance":"50"},{"GeneralIndex":"3111"}]}}]]',
},
};
const opts = {
injectedRegistry: {
westend: {
'4000': {
poolPairsInfo,
},
},
},
overridingRegistry: {
westend: {
'4000': {
poolPairsInfo,
},
},
},
};

const registry = parseRegistry(reg as ChainInfoRegistry<ChainInfoKeys>, opts);

expect(registry.westend['4000'].poolPairsInfo['9']).toStrictEqual({
lpToken: '9',
pairInfo:
'[[{"parents":"0","interior":"Here"},{"parents":"1","interior":{"X2":[{"PalletInstance":"50"},{"GeneralIndex":"3111"}]}}]]',
});
expect(registry.westend['4000'].poolPairsInfo['8']).toStrictEqual({
lpToken: '8',
pairInfo:
'[[{"parents":"2","interior":"Here"},{"parents":"1","interior":{"X2":[{"PalletInstance":"50"},{"GeneralIndex":"25"}]}}]]',
});
});
it('Should correctly add a new foreignAsset and update the specName', () => {
const specName = 'prorrata';
const foreignAssetsInfo = {
TESTY: {
symbol: 'TSTY',
name: 'Testy',
multiLocation: '{"parents":"2","interior":{"X1":{"GlobalConsensus":"Testy"}}}',
},
};
const opts = {
overridingRegistry: {
rococo: {
'4000': {
specName,
foreignAssetsInfo,
},
},
},
};
const registry = parseRegistry(reg as ChainInfoRegistry<ChainInfoKeys>, opts);

expect(registry.rococo['4000'].tokens).toStrictEqual(['TRM']);
expect(registry.rococo['4000'].foreignAssetsInfo).toStrictEqual({
TESTY: {
symbol: 'TSTY',
name: 'Testy',
multiLocation: '{"parents":"2","interior":{"X1":{"GlobalConsensus":"Testy"}}}',
},
});
expect(registry.rococo['4000'].specName).toStrictEqual('prorrata');
});
});
Loading