Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | 41x 41x 41x 41x 41x 41x 41x 41x 41x 41x 41x 41x 5x 12x 12x 12x 12x 10x 10x 8x 4x 2x 1x 1x 2x 2x 5x 5x 5x 4x 4x 1x 3x 1x 1x 5x 5x 2x 3x 3x 3x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x | /* eslint-disable max-len */
/* eslint-disable complexity */
/* eslint-disable sonarjs/cognitive-complexity */
/* eslint-disable max-depth */
import * as Crypto from '@cardano-sdk/crypto';
import { CustomError } from 'ts-custom-error';
import { HexBlob } from '@cardano-sdk/util';
import { Logger } from 'ts-log';
import { StakePoolExtMetadataResponse, StakePoolMetadataService } from '../types';
import { StakePoolMetadataServiceError, StakePoolMetadataServiceFailure } from './errors';
import { ValidationError, validate } from 'jsonschema';
import { getExtMetadataUrl, getSchemaFormat, loadJsonSchema } from './util';
import { mapToExtendedMetadata } from './mappers';
import axios, { AxiosInstance } from 'axios';
const HTTP_CLIENT_TIMEOUT = 2 * 1000;
const HTTP_CLIENT_MAX_CONTENT_LENGTH = 5000;
const SERVICE_NAME = 'StakePoolMetadataService';
export const createHttpStakePoolMetadataService = (
logger: Logger,
axiosClient: AxiosInstance = axios.create({
maxContentLength: HTTP_CLIENT_MAX_CONTENT_LENGTH,
timeout: HTTP_CLIENT_TIMEOUT
})
): StakePoolMetadataService => ({
async getStakePoolExtendedMetadata(metadata, config = {}) {
const url = getExtMetadataUrl(metadata);
try {
logger.debug('About to fetch stake pool extended metadata');
const { data } = await axiosClient.get<StakePoolExtMetadataResponse>(url, config);
const schema = loadJsonSchema(getSchemaFormat(metadata));
validate(data, schema, { throwError: true });
return mapToExtendedMetadata(data);
} catch (error) {
if (axios.isAxiosError(error)) {
if (error.response?.status === 404) {
throw new StakePoolMetadataServiceError(
StakePoolMetadataServiceFailure.FailedToFetchExtendedMetadata,
error,
`${SERVICE_NAME} failed to fetch extended metadata from ${url} due to resource not found`
);
}
throw new StakePoolMetadataServiceError(
StakePoolMetadataServiceFailure.FailedToFetchExtendedMetadata,
error,
`${SERVICE_NAME} failed to fetch extended metadata from ${url} due to connection error`
);
}
if (error instanceof ValidationError) {
throw new StakePoolMetadataServiceError(
StakePoolMetadataServiceFailure.InvalidExtendedMetadataFormat,
error,
'Extended metadata JSON format validation failed against the corresponding schema for correctness'
);
}
throw error;
}
},
async getStakePoolMetadata(hash, url) {
try {
logger.debug(`About to fetch stake pool metadata JSON from ${url}`);
// Fetch metadata as byte array
const { data } = await axiosClient.get<Uint8Array>(url, { responseType: 'arraybuffer' });
// Produce metadata hash
const metadataHash = Crypto.blake2b(Crypto.blake2b.BYTES).update(data).digest('hex');
// Verify base hashes
if (metadataHash !== hash) {
return new StakePoolMetadataServiceError(
StakePoolMetadataServiceFailure.InvalidStakePoolHash,
null,
`Invalid stake pool hash. Computed '${metadataHash}', expected '${hash}'`
);
}
// Transform fetched metadata from bytes array to JSON
return JSON.parse(data.toString());
} catch (error) {
if (axios.isAxiosError(error)) {
return new StakePoolMetadataServiceError(
StakePoolMetadataServiceFailure.FailedToFetchMetadata,
error.toJSON(),
`${SERVICE_NAME} failed to fetch metadata JSON from ${url} due to ${error.message}`
);
} else IEif (error instanceof StakePoolMetadataServiceError) {
return error;
}
return new StakePoolMetadataServiceError(
StakePoolMetadataServiceFailure.Unknown,
JSON.stringify(error),
`${SERVICE_NAME} failed to fetch metadata JSON from ${url} due to ${
error instanceof Error ? error.message : 'unknown error'
}`
);
}
},
async getValidateStakePoolExtendedMetadata(metadata) {
Iif (!metadata?.extDataUrl && !metadata?.extended) return;
// Validate CIP-6 ext metadata fields
if (metadata.extDataUrl && (!metadata.extSigUrl || !metadata.extVkey)) {
return new StakePoolMetadataServiceError(
StakePoolMetadataServiceFailure.InvalidMetadata,
null,
'Missing ext signature or public key'
);
}
// Fetch extended metadata (supports both cip-6 and ada pools formats already)
try {
const extMetadata = await this.getStakePoolExtendedMetadata(metadata);
// In case of CIP-6 standard -> perform signature verification
if (metadata.extDataUrl && metadata.extSigUrl && metadata.extVkey) {
// Based on the CIP-6, we have `extSigUrl` (A URL with the extended metadata signature), so we need to make another HTTP request to get the actual signature
try {
const signature = (await axiosClient.get<Crypto.Ed25519SignatureHex>(metadata.extSigUrl)).data;
const message = HexBlob.fromBytes(Buffer.from(JSON.stringify(extMetadata)));
const publicKey = Crypto.Ed25519PublicKeyHex(metadata.extVkey);
const bip32Ed25519 = new Crypto.SodiumBip32Ed25519();
// Verify the signature
const isSignatureValid = await bip32Ed25519.verify(signature, message, publicKey);
// If not valid -> omit extended metadata from response and add specific error
if (!isSignatureValid) {
return new StakePoolMetadataServiceError(
StakePoolMetadataServiceFailure.InvalidExtendedMetadataSignature,
null,
'Invalid extended metadata signature'
);
}
// If signature url failed -> omit extended metadata from response and add specific error
} catch (error) {
return new StakePoolMetadataServiceError(
StakePoolMetadataServiceFailure.FailedToFetchExtendedSignature,
error,
`${SERVICE_NAME} failed to fetch extended signature from ${metadata.extSigUrl} due to connection error`
);
}
}
return extMetadata;
} catch (error) {
Iif (error instanceof CustomError) return error;
return new StakePoolMetadataServiceError(
StakePoolMetadataServiceFailure.Unknown,
JSON.stringify(error),
`${SERVICE_NAME} failed to get extended metadata due to ${
error instanceof Error ? error.message : 'unknown error'
}`
);
}
}
});
|