@cardano-sdk/cardano-services 0.6.0-nightly.9 → 0.6.1-nightly.0

package/dist/cjs/StakePool/HttpStakePoolMetadata/schemas/schemas/cip-6.json

@@ -0,0 +1,276 @@
+{
+  "$id": "https://raw.githubusercontent.com/cardano-foundation/CIPs/master/CIP-0006/schema.json",
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "default": {},
+  "description": "Additional information for Cardano Stake Pools in CIP-6 format",
+  "examples": [
+    {
+      "serial": 2020072001,
+      "pool": {
+        "id": "5ee7591bf30eaa4f5dce70b4a676eb02d5be8012d188f04fe3beffb0",
+        "country": "DE",
+        "status": "active",
+        "contact": {
+          "primary": "email",
+          "email": "help@pooldomain.org",
+          "facebook": "demopool",
+          "github": "demopool",
+          "feed": "https://demopool.com/xml/poolrss.xml",
+          "telegram": "demopool",
+          "twitter": "demopool"
+        },
+        "media_assets": {
+          "icon_png_64x64": "https://mydemopool.com/icon.png",
+          "logo_png": "https://mydemopool.com/logo.png",
+          "logo_svg": "https://mydemopool.com/logo.svg",
+          "color_fg": "#RRGGBB",
+          "color_bg": "#RRGGBB"
+        },
+        "itn": {
+          "owner": "ed25519_pk1...",
+          "witness": "ed25519_sig1..."
+        }
+      }
+    }
+  ],
+  "maxLength": 4096,
+  "required": [
+    "serial",
+    "pool"
+  ],
+  "title": "Extended stake pool metadata",
+  "type": "object",
+  "properties": {
+    "serial": {
+      "$id": "#/properties/serial",
+      "default": 0,
+      "description": "Integer number incremented on every update, by using YYYYMMDDxx (xx each day start by 01 and is incremented on each update",
+      "examples": [
+        2021012001
+      ],
+      "maxLength": 10,
+      "minLength": 10,
+      "required": [],
+      "title": "serial number",
+      "type": "integer"
+    },
+    "pool": {
+      "$id": "#/properties/pool",
+      "default": {},
+      "description": "pool related metadata",
+      "required": [
+        "id"
+      ],
+      "title": "stake pool",
+      "type": "object",
+      "properties": {
+        "id": {
+          "$id": "#/properties/pool/properties/id",
+          "type": "string",
+          "title": "Pool ID",
+          "description": "the pools unique id in hex format",
+          "maxLength": 56,
+          "minLength": 56,
+          "examples": [
+            "5ee7591bf30eaa4f5dce70b4a676eb02d5be8012d188f04fe3beffb0"
+          ]
+        },
+        "country": {
+          "$id": "#/properties/pool/properties/country",
+          "default": "",
+          "description": "3 letter country code as defined in https://www.iso.org/iso-3166-country-codes.html (alpha-3)",
+          "maxLength": 20,
+          "minLength": 2,
+          "examples": [
+            "JPN"
+          ],
+          "title": "declared pool location",
+          "type": "string"
+        },
+        "status": {
+          "$id": "#/properties/pool/properties/status",
+          "default": "",
+          "maxLength": 12,
+          "description": "the current operative status (see examples).",
+          "examples": [
+            "active",
+            "retired",
+            "offline",
+            "experimental",
+            "private"
+          ],
+          "title": "pool status",
+          "type": "string"
+        },
+        "contact": {
+          "$id": "#/properties/pool/properties/contact",
+          "default": {},
+          "description": "Optional contact information.",
+          "examples": [
+            {
+              "primary": "email",
+              "email": "help@demopool.org",
+              "facebook": "demopool",
+              "github": "demopool",
+              "feed": "https://mydemopool.com/xml/poolrss.xml",
+              "telegram": "demopool",
+              "telegram_channel": "https://t.me/coolchannel",
+              "twitter": "demopool"
+            }
+          ],
+          "required": [
+            "primary"
+          ],
+          "title": "Pool contact data",
+          "type": "object",
+          "properties": {
+            "primary": {
+              "$id": "#/properties/pool/properties/contact/properties/primary",
+              "default": "email",
+              "description": "the pools preferred communication channel",
+              "title": "primary contact preference",
+              "type": "string"
+            },
+            "email": {
+              "$id": "#/properties/pool/properties/contact/properties/email",
+              "description": "valid email contact address",
+              "title": "email address",
+              "type": "string"
+            },
+            "facebook": {
+              "$id": "#/properties/pool/properties/contact/properties/facebook",
+              "description": "a user or page name",
+              "title": "facebook account",
+              "examples": [
+                "demopool"
+              ],
+              "type": "string"
+            },
+            "github": {
+              "$id": "#/properties/pool/properties/contact/properties/github",
+              "description": "a github username",
+              "examples": [
+                "demopool"
+              ],
+              "title": "github account",
+              "type": "string"
+            },
+            "feed": {
+              "$id": "#/properties/pool/properties/contact/properties/feed",
+              "default": "",
+              "description": "RSS feed URL",
+              "examples": [
+                "https://mydemopool.com/xml/poolrss.xml"
+              ],
+              "title": "RSS feed",
+              "type": "string"
+            },
+            "telegram": {
+              "$id": "#/properties/pool/properties/contact/properties/telegram",
+              "description": "a telegram username",
+              "examples": [
+                "demopool"
+              ],
+              "title": "telegram account",
+              "type": "string"
+            },
+            "twitter": {
+              "$id": "#/properties/pool/properties/contact/properties/twitter",
+              "description": "a twitter username",
+              "examples": [
+                "demopool"
+              ],
+              "title": "twitter account",
+              "type": "string"
+            }
+          }
+        },
+        "media_assets": {
+          "$id": "#/properties/pool/properties/media_assets",
+          "type": "object",
+          "title": "The pools media assets",
+          "description": "Media file URLs and colors",
+          "required": [
+            "icon_png_64x64"
+          ],
+          "properties": {
+            "icon_png_64x64": {
+              "$id": "#/properties/pool/properties/media_assets/properties/icon_png_64x64",
+              "type": "string",
+              "title": "Pool Icon in PNG file format 64x64 px",
+              "description": "PNG image with exact 64x64 pixel size",
+              "examples": [
+                "https://mydemopool.com/media/icon64.png"
+              ]
+            },
+            "logo_png": {
+              "$id": "#/properties/pool/properties/media_assets/properties/logo_png",
+              "type": "string",
+              "title": "Pool Logo in PNG file format",
+              "description": "PNG image (should have less than 250 kByte of file size)",
+              "examples": [
+                "https://mydemopool.com/media/logo.png"
+              ]
+            },
+            "logo_svg": {
+              "$id": "#/properties/pool/properties/media_assets/properties/logo_svg",
+              "type": "string",
+              "title": "Pool Logo in SVG file format",
+              "description": "(should have less tha 250 kByte of file size)",
+              "examples": [
+                "https://mydemopool.com/media/logo.svg"
+              ]
+            },
+            "color_fg": {
+              "$id": "#/properties/pool/properties/media_assets/properties/color_fg",
+              "type": "string",
+              "title": "Pool primary color",
+              "description": "RGB color code.",
+              "examples": [
+                "#AABBCC"
+              ]
+            },
+            "color_bg": {
+              "$id": "#/properties/pool/properties/media_assets/properties/color_bg",
+              "type": "string",
+              "title": "Pool secondary color",
+              "description": "RGB color code.",
+              "default": "",
+              "examples": [
+                "#C0C0C0"
+              ]
+            }
+          }
+        },
+        "itn": {
+          "$id": "#/properties/pool/properties/itn",
+          "type": "object",
+          "title": "ITN verification",
+          "description": "A proof of ownership for an established ITN pool brand.",
+          "required": [
+            "owner",
+            "witness"
+          ],
+          "properties": {
+            "owner": {
+              "$id": "#/properties/pool/properties/itn/properties/owner",
+              "type": "string",
+              "title": "the ITN pool owner public key",
+              "examples": [
+                "ed25519_pk1..."
+              ]
+            },
+            "witness": {
+              "$id": "#/properties/pool/properties/itn/properties/witness",
+              "type": "string",
+              "title": "the secret key generated witness",
+              "examples": [
+                "ed25519_sig1..."
+              ]
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/dist/cjs/StakePool/HttpStakePoolMetadata/types.d.ts

@@ -0,0 +1,74 @@
+export declare type PoolCompanyInfo = {
+    name?: string;
+    addr?: string;
+    city?: string;
+    country?: string;
+    company_id?: string;
+    vat_id?: string;
+};
+export declare type PoolSocialData = {
+    twitter_handle?: string;
+    telegram_handle?: string;
+    facebook_handle?: string;
+    youtube_handle?: string;
+    twitch_handle?: string;
+    discord_handle?: string;
+    github_handle?: string;
+};
+export declare type PoolAboutInfo = {
+    me?: string;
+    server?: string;
+    company?: string;
+};
+export declare type APExtendedStakePoolMetadataFields = {
+    url_png_icon_64x64?: string;
+    url_png_logo?: string;
+    location?: string;
+    social?: PoolSocialData;
+    company?: PoolCompanyInfo;
+    about?: PoolAboutInfo;
+};
+export declare type APExtMetadataResponse = {
+    info: APExtendedStakePoolMetadataFields;
+    [k: string]: unknown;
+};
+export declare enum ExtendedPoolStatus {
+    Active = "active",
+    Retired = "retired",
+    Offline = "offline",
+    Experimental = "experimental",
+    Private = "private"
+}
+export declare type PoolContactData = {
+    primary: string;
+    email?: string;
+    facebook?: string;
+    github?: string;
+    feed?: string;
+    telegram?: string;
+    twitter?: string;
+};
+export declare type ThePoolsMediaAssets = {
+    icon_png_64x64: string;
+    logo_png?: string;
+    logo_svg?: string;
+    color_fg?: string;
+    color_bg?: string;
+};
+export declare type ITNVerification = {
+    owner: string;
+    witness: string;
+};
+export declare type Cip6ExtendedStakePoolMetadataFields = {
+    id: string;
+    country?: string;
+    status?: ExtendedPoolStatus;
+    contact?: PoolContactData;
+    media_assets?: ThePoolsMediaAssets;
+    itn?: ITNVerification;
+};
+export declare type Cip6ExtMetadataResponse = {
+    serial: number;
+    pool: Cip6ExtendedStakePoolMetadataFields;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/cjs/StakePool/HttpStakePoolMetadata/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/StakePool/HttpStakePoolMetadata/types.ts"],"names":[],"mappings":"AAIA,oBAAY,eAAe,GAAG;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,oBAAY,cAAc,GAAG;IAC3B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,oBAAY,aAAa,GAAG;IAC1B,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,oBAAY,iCAAiC,GAAG;IAC9C,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,KAAK,CAAC,EAAE,aAAa,CAAC;CACvB,CAAC;AAEF,oBAAY,qBAAqB,GAAG;IAClC,IAAI,EAAE,iCAAiC,CAAC;IACxC,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB,CAAC;AAMF,oBAAY,kBAAkB;IAC5B,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,YAAY,iBAAiB;IAC7B,OAAO,YAAY;CACpB;AAED,oBAAY,eAAe,GAAG;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,oBAAY,mBAAmB,GAAG;IAChC,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,oBAAY,eAAe,GAAG;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,oBAAY,mCAAmC,GAAG;IAChD,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,YAAY,CAAC,EAAE,mBAAmB,CAAC;IACnC,GAAG,CAAC,EAAE,eAAe,CAAC;CACvB,CAAC;AAEF,oBAAY,uBAAuB,GAAG;IACpC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,mCAAmC,CAAC;CAC3C,CAAC"}

package/dist/cjs/StakePool/HttpStakePoolMetadata/types.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtendedPoolStatus = void 0;
+var ExtendedPoolStatus;
+(function (ExtendedPoolStatus) {
+    ExtendedPoolStatus["Active"] = "active";
+    ExtendedPoolStatus["Retired"] = "retired";
+    ExtendedPoolStatus["Offline"] = "offline";
+    ExtendedPoolStatus["Experimental"] = "experimental";
+    ExtendedPoolStatus["Private"] = "private";
+})(ExtendedPoolStatus = exports.ExtendedPoolStatus || (exports.ExtendedPoolStatus = {}));
+//# sourceMappingURL=types.js.map

package/dist/cjs/StakePool/HttpStakePoolMetadata/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/StakePool/HttpStakePoolMetadata/types.ts"],"names":[],"mappings":";;;AA+CA,IAAY,kBAMX;AAND,WAAY,kBAAkB;IAC5B,uCAAiB,CAAA;IACjB,yCAAmB,CAAA;IACnB,yCAAmB,CAAA;IACnB,mDAA6B,CAAA;IAC7B,yCAAmB,CAAA;AACrB,CAAC,EANW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAM7B"}

package/dist/cjs/StakePool/HttpStakePoolMetadata/util.d.ts

@@ -0,0 +1,8 @@
+import { Cardano } from '@cardano-sdk/core';
+import { Cip6ExtMetadataResponse } from './types';
+import { ExtMetadataFormat, StakePoolExtMetadataResponse } from '../types';
+export declare const getExtMetadataUrl: (metadata: Cardano.StakePoolMetadata) => string;
+export declare const getSchemaFormat: (value: Cardano.StakePoolMetadata) => ExtMetadataFormat;
+export declare const loadJsonSchema: (format: ExtMetadataFormat) => JSON;
+export declare const isCip6Format: (response: StakePoolExtMetadataResponse) => response is Cip6ExtMetadataResponse;
+//# sourceMappingURL=util.d.ts.map

package/dist/cjs/StakePool/HttpStakePoolMetadata/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../../../src/StakePool/HttpStakePoolMetadata/util.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,OAAO,EAAE,uBAAuB,EAAE,MAAM,SAAS,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,4BAA4B,EAAE,MAAM,UAAU,CAAC;AAa3E,eAAO,MAAM,iBAAiB,aAAc,QAAQ,iBAAiB,WAA8C,CAAC;AAUpH,eAAO,MAAM,eAAe,UAAW,QAAQ,iBAAiB,KAAG,iBACe,CAAC;AAKnF,eAAO,MAAM,cAAc,WAAY,iBAAiB,KAAG,IAG1D,CAAC;AAKF,eAAO,MAAM,YAAY,aAAc,4BAA4B,wCACb,CAAC"}

package/dist/cjs/StakePool/HttpStakePoolMetadata/util.js

@@ -0,0 +1,22 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCip6Format = exports.loadJsonSchema = exports.getSchemaFormat = exports.getExtMetadataUrl = void 0;
+const types_1 = require("../types");
+const util_1 = require("@cardano-sdk/util");
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const getExtMetadataUrl = (metadata) => metadata.extDataUrl ?? metadata.extended;
+exports.getExtMetadataUrl = getExtMetadataUrl;
+const getSchemaFormat = (value) => (0, util_1.isNotNil)(value.extDataUrl) ? types_1.ExtMetadataFormat.CIP6 : types_1.ExtMetadataFormat.AdaPools;
+exports.getSchemaFormat = getSchemaFormat;
+const loadJsonSchema = (format) => {
+    const schemaPath = path_1.default.join(__dirname, 'schemas', `${format}.json`);
+    return JSON.parse(fs_1.default.readFileSync(schemaPath, 'utf8'));
+};
+exports.loadJsonSchema = loadJsonSchema;
+const isCip6Format = (response) => (0, util_1.isNotNil)(response.pool) || (0, util_1.isNotNil)(response.serial);
+exports.isCip6Format = isCip6Format;
+//# sourceMappingURL=util.js.map

package/dist/cjs/StakePool/HttpStakePoolMetadata/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../../../src/StakePool/HttpStakePoolMetadata/util.ts"],"names":[],"mappings":";;;;;;AAGA,oCAA2E;AAC3E,4CAA6C;AAC7C,4CAAoB;AACpB,gDAAwB;AAUjB,MAAM,iBAAiB,GAAG,CAAC,QAAmC,EAAE,EAAE,CAAC,QAAQ,CAAC,UAAU,IAAI,QAAQ,CAAC,QAAS,CAAC;AAAvG,QAAA,iBAAiB,qBAAsF;AAU7G,MAAM,eAAe,GAAG,CAAC,KAAgC,EAAqB,EAAE,CACrF,IAAA,eAAQ,EAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,yBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC,yBAAiB,CAAC,QAAQ,CAAC;AADtE,QAAA,eAAe,mBACuD;AAK5E,MAAM,cAAc,GAAG,CAAC,MAAyB,EAAQ,EAAE;IAChE,MAAM,UAAU,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,EAAE,GAAG,MAAM,OAAO,CAAC,CAAC;IACrE,OAAO,IAAI,CAAC,KAAK,CAAC,YAAE,CAAC,YAAY,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC,CAAC;AACzD,CAAC,CAAC;AAHW,QAAA,cAAc,kBAGzB;AAKK,MAAM,YAAY,GAAG,CAAC,QAAsC,EAAuC,EAAE,CAC1G,IAAA,eAAQ,EAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAA,eAAQ,EAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AAD1C,QAAA,YAAY,gBAC8B"}

package/dist/cjs/StakePool/index.d.ts

@@ -1,3 +1,5 @@
 export * from './DbSyncStakePoolProvider';
 export * from './StakePoolHttpService';
+export * from './HttpStakePoolMetadata';
+export * from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/StakePool/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/StakePool/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/StakePool/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAC;AAC1C,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,SAAS,CAAC"}

package/dist/cjs/StakePool/index.js

@@ -16,4 +16,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./DbSyncStakePoolProvider"), exports);
 __exportStar(require("./StakePoolHttpService"), exports);
+__exportStar(require("./HttpStakePoolMetadata"), exports);
+__exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/StakePool/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/StakePool/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAA0C;AAC1C,yDAAuC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/StakePool/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4DAA0C;AAC1C,yDAAuC;AACvC,0DAAwC;AACxC,0CAAwB"}