Skip to content

feat: add metadata versions endpoints #1424

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
Imod7 merged 8 commits into from
Apr 4, 2024
Merged

feat: add metadata versions endpoints #1424

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
53a2a0d
feat: add metadata versions endpoints
Imod7 Apr 2, 2024
294f9a1
updated docs
Imod7 Apr 3, 2024
16d554f
fix typo & renamed variables
Imod7 Apr 3, 2024
17007a2
made the metadata version check dynamic, replacing the specific check…
Imod7 Apr 3, 2024
132d1b1
added changes from Tarik's review
Imod7 Apr 4, 2024
2afcf60
Tarik's change on regExPattern check
Imod7 Apr 4, 2024
c3460b9
added Tarik's suggestion also in transaction material
Imod7 Apr 4, 2024
e63db36
fix typo
Imod7 Apr 4, 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
Prev Previous commit
Next Next commit
made the metadata version check dynamic, replacing the specific check… 
… for versions 14 and 15

- transaction material with metadata returns metadata regardless of the 'metadata' query param
- updated docs
  • Loading branch information
@Imod7
Imod7 committed Apr 3, 2024
commit 17007a2dee3cd26aabdabc5823644d55c2c89f40
2 changes: 1 addition & 1 deletion docs/dist/app.bundle.js
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion docs/src/openapi-v1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1167,7 +1167,9 @@ paths:
- name: metadataVersion
in: path
description: The version of metadata. The input is expected in a `vX` format, where `X`
represents the version number (e.g. `v14`, `v15`).
represents the version number (e.g. `v14`, `v15`). By default, metadata is outputted
in 'JSON' format, unless the `metadata` query parameter is provided, in which case it can be
either in 'JSON' or 'SCALE' format.
Copy link
Member

@TarikGul TarikGul Apr 3, 2024

Choose a reason for hiding this comment

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

I think JSON, and SCALE should be lower case here to be consistent

required: true
schema:
type: string
Expand Down
6 changes: 1 addition & 5 deletions src/services/runtime/RuntimeMetadataService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,7 @@ export class RuntimeMetadataService extends AbstractService {
let metadata: Option<OpaqueMetadata> | undefined;
let metadataVersioned: Metadata | undefined;
try {
if (metadataVersion === 14) {
metadata = await apiAt.call.metadata.metadataAtVersion(14);
} else if (metadataVersion === 15) {
metadata = await apiAt.call.metadata.metadataAtVersion(15);
}
metadata = await apiAt.call.metadata.metadataAtVersion(metadataVersion);
if (metadata) {
metadataVersioned = new Metadata(apiAt.registry, metadata.unwrap());
} else {
Expand Down
31 changes: 2 additions & 29 deletions src/services/transaction/TransactionMaterialService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,29 +93,6 @@ export class TransactionMaterialService extends AbstractService {
): Promise<ITransactionMaterial> {
const { api } = this;

if (!metadataArg) {
const [header, genesisHash, name, version] = await Promise.all([
api.rpc.chain.getHeader(hash),
api.rpc.chain.getBlockHash(0),
api.rpc.system.chain(),
api.rpc.state.getRuntimeVersion(hash),
]);

const at = {
hash,
height: header.number.toNumber().toString(10),
};

return {
at,
genesisHash,
chainName: name.toString(),
specName: version.specName.toString(),
specVersion: version.specVersion,
txVersion: version.transactionVersion,
};
}

const [header, genesisHash, name, version] = await Promise.all([
api.rpc.chain.getHeader(hash),
api.rpc.chain.getBlockHash(0),
Expand All @@ -128,11 +105,7 @@ export class TransactionMaterialService extends AbstractService {
let metadata: Option<OpaqueMetadata> | undefined;
let metadataVersioned: Metadata | undefined;
try {
if (metadataVersion === 14) {
metadata = await apiAt.call.metadata.metadataAtVersion(14);
} else if (metadataVersion === 15) {
metadata = await apiAt.call.metadata.metadataAtVersion(15);
}
metadata = await apiAt.call.metadata.metadataAtVersion(metadataVersion);
if (metadata) {
metadataVersioned = new Metadata(apiAt.registry, metadata.unwrap());
} else {
Expand All @@ -149,7 +122,7 @@ export class TransactionMaterialService extends AbstractService {
height: header.number.toNumber().toString(10),
};

const formattedMeta = metadataArg === 'scale' ? metadata.toHex() : metadataVersioned.toJSON();
const formattedMeta = metadataArg === 'scale' ? metadata.toString() : metadataVersioned.toJSON();

return {
at,
Expand Down