From 2b29b40202b7c9fe53469a130234acb6226082b5 Mon Sep 17 00:00:00 2001 From: Mike Date: Mon, 20 Jul 2020 11:45:03 -0700 Subject: [PATCH 01/11] Create CIP6.md --- CIP6/CIP6.md | 64 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 CIP6/CIP6.md diff --git a/CIP6/CIP6.md b/CIP6/CIP6.md new file mode 100644 index 000000000..cc8452b47 --- /dev/null +++ b/CIP6/CIP6.md @@ -0,0 +1,64 @@ +--- +CIP: 6 +Title: Extended Metadata +Authors: Mike Fullman , Markus <> +Comments-URI: +Status: Draft +Type: Standards +Created: 2020-07-20 +License: Apache-2.0 +--- + +## Abstract + +This CIP defines the concept of extended metadata for pools that is referenced from the pool registration data stored on chain. + +## Motivation + +As the ecosystem around cardano stake pools proliferate so will the desire to slice, organize and search pool information dynamically. Currently the metadata refernced on chain provides 512 bytes that can be allocated across the four information categories: + +| key | Value | Rules | +| --- | --- | --- | +| `ticker` | Pool ticker. uppercase | 5 Characters Maximum, Uppercase letters and numbers | +| `description` | Pool Description. Text that describes the pool | 50 Characters Maximum | +| `homepage` | A website URL for the pool | 64 Characters Maximum, must be a valid URL | +| `name` | A name for the pool | 50 Characters Maximum | + +Many additional attributes can be envisioned for future wallets, pool explorers, and information aggregators. The proposal below outlines an initial strategy for capturing this extended metadata. + +## Specification + +#### On Chain referenced metadata file +We define one more line for the on chain referenced metadata file that references another json file on a url with the extended metadata. The proposed metadata is as follows: + +| key | Value | Rules | +| --- | --- | --- | +| `ticker` | Pool ticker. uppercase | 5 Characters Maximum, Uppercase letters and numbers | +| `description` | Pool Description. Text that describes the pool | 50 Characters Maximum | +| `homepage` | A website URL for the pool| 64 Characters Maximum, must be a valid URL | +| `name` | A name for the pool | 50 Characters Maximum | +| `extended` | A url for extended metadata| Optional, 64 Characters Maximum, must be a valid URL | + +#### Extended Metadata +The file located at the URL for extended data is a json compliant text file with the following fields: + +| key | Value | Rules | +| --- | --- | --- | +| `itn.owner` | ITN pool public key | TBD | +| `itn.witness` | Signature of mainnet pool id signed by teh ITN pool secret key | TBD | + +#### Extended Metadata Schema + +TBD + +## Backwards compatibility + +No fields are removed or changed in the current on chain metadata. The new field `extended` is optional and not necessary to parse for any entities that do not need additional information about a pool + +## Reference implementation + +N/A + +## Copyright + +This CIP is licensed under Apache-2.0. From 71b58a651483d3ada221ec665d93fbd256066b10 Mon Sep 17 00:00:00 2001 From: Markus Date: Tue, 21 Jul 2020 11:49:08 +0200 Subject: [PATCH 02/11] metadata schema, little additions --- CIP6/CIP6.md | 267 +++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 258 insertions(+), 9 deletions(-) diff --git a/CIP6/CIP6.md b/CIP6/CIP6.md index cc8452b47..0741d92c0 100644 --- a/CIP6/CIP6.md +++ b/CIP6/CIP6.md @@ -1,7 +1,7 @@ --- CIP: 6 Title: Extended Metadata -Authors: Mike Fullman , Markus <> +Authors: Mike Fullman , Markus Gufler Comments-URI: Status: Draft Type: Standards @@ -15,9 +15,9 @@ This CIP defines the concept of extended metadata for pools that is referenced f ## Motivation -As the ecosystem around cardano stake pools proliferate so will the desire to slice, organize and search pool information dynamically. Currently the metadata refernced on chain provides 512 bytes that can be allocated across the four information categories: +As the ecosystem around Cardano stake pools proliferate so will the desire to slice, organize and search pool information dynamically. Currently the metadata referenced on chain provides 512 bytes that can be allocated across the four information categories ([delegation-design-specification Section 4.2)](https://hydra.iohk.io/build/790053/download/1/delegation_design_spec.pdf): -| key | Value | Rules | +| key | Value | Rules | | --- | --- | --- | | `ticker` | Pool ticker. uppercase | 5 Characters Maximum, Uppercase letters and numbers | | `description` | Pool Description. Text that describes the pool | 50 Characters Maximum | @@ -25,13 +25,13 @@ As the ecosystem around cardano stake pools proliferate so will the desire to sl | `name` | A name for the pool | 50 Characters Maximum | Many additional attributes can be envisioned for future wallets, pool explorers, and information aggregators. The proposal below outlines an initial strategy for capturing this extended metadata. - + ## Specification #### On Chain referenced metadata file We define one more line for the on chain referenced metadata file that references another json file on a url with the extended metadata. The proposed metadata is as follows: -| key | Value | Rules | +| key | Value | Rules | | --- | --- | --- | | `ticker` | Pool ticker. uppercase | 5 Characters Maximum, Uppercase letters and numbers | | `description` | Pool Description. Text that describes the pool | 50 Characters Maximum | @@ -42,14 +42,263 @@ We define one more line for the on chain referenced metadata file that reference #### Extended Metadata The file located at the URL for extended data is a json compliant text file with the following fields: -| key | Value | Rules | +| key | Value | Rules | | --- | --- | --- | -| `itn.owner` | ITN pool public key | TBD | -| `itn.witness` | Signature of mainnet pool id signed by teh ITN pool secret key | TBD | +| `serial` | set to YYYYMMDDxx on every update | regex: `\d{10}` | +| `itn.owner` | ITN pool public key | regex: `ed25519_pk1[a-z0-9]{58}` | +| `itn.witness` | Mainnet pool id signed by the ITN pool owner secret key | regex: `ed25519_sig1[a-z0-9]{109}` | + +Since this extended metadata file has no checksum and can be updated at any time by the pool operator, a **serial number** is useful to easily identify updates. + +The purpose of this first (**itn**) extension is the verifiable linking of an ITN pool ticker with its counterpart in Mainnet to identify fraudulent duplicates. + + #### Extended Metadata Schema -TBD +``` +{ + "$schema": "http://json-schema.org/draft-07/schema", + "$id": "http://example.com/example.json", + "type": "object", + "title": "The root schema", + "description": "The root schema comprises the entire JSON document.", + "default": {}, + "examples": [ + { + "serial": 2020072001, + "itn": { + "owner": "ed25519_pk1...", + "witness": "ed25519_sig1..." + }, + "contact": { + "abuse": "abuse@pooldomain.org", + "support": "help@pooldomain.org", + "social": { + "discord": "discordUser#1234", + "telegram": "@telegramUser", + "facebook": "facebookUser", + "reddit": "redditUser", + "twitter": "@twitterAccount" + } + }, + "CI": { + "color-main": "#RRGGBB", + "logo-vector": "" + } + } + ], + "required": [ + "serial" + ], + "additionalProperties": true, + "properties": { + "serial": { + "$id": "#/properties/serial", + "type": "integer", + "title": "serial number", + "description": "YYYYMMDDxx set on every update", + "default": 0, + "examples": [ + 2020072001 + ], + "pattern": "`\\d{10}`" + }, + "itn": { + "$id": "#/properties/itn", + "type": "object", + "title": "ITN relations", + "description": "Link incentivised-testnet and mainnet tickers", + "default": {}, + "examples": [ + { + "owner": "ed25519_pk1...", + "witness": "ed25519_sig1..." + } + ], + "required": [], + "additionalProperties": true, + "properties": { + "owner": { + "$id": "#/properties/itn/properties/owner", + "type": "string", + "title": "owner public key", + "description": "", + "default": "", + "examples": [ + "ed25519_pk1..." + ], + "pattern": "`ed25519_pk1[a-z0-9]{58}`" + }, + "witness": { + "$id": "#/properties/itn/properties/witness", + "type": "string", + "title": "signed pool id", + "description": "Mainnet pool id signed by the ITN pool owner secret key", + "default": "", + "examples": [ + "ed25519_sig1..." + ], + "pattern": "`ed25519_sig1[a-z0-9]{109}`" + } + } + }, + "contact": { + "$id": "#/properties/contact", + "type": "object", + "title": "The contact schema", + "description": "additional contact options", + "default": {}, + "examples": [ + { + "abuse": "abuse@pooldomain.org", + "support": "help@pooldomain.org", + "social": { + "discord": "discordUser#1234", + "telegram": "@telegramUser", + "facebook": "facebookUser", + "reddit": "redditUser", + "twitter": "@twitterAccount" + } + } + ], + "required": [], + "additionalProperties": true, + "properties": { + "abuse": { + "$id": "#/properties/contact/properties/abuse", + "type": "string", + "title": "abuse contact", + "description": "email address", + "default": "", + "examples": [ + "abuse@pooldomain.org" + ] + }, + "support": { + "$id": "#/properties/contact/properties/support", + "type": "string", + "title": "support contact", + "description": "email address", + "default": "", + "examples": [ + "help@pooldomain.org" + ] + }, + "social": { + "$id": "#/properties/contact/properties/social", + "type": "object", + "title": "social channels", + "description": "optional social channels.", + "default": {}, + "examples": [ + { + "discord": "discordUser#1234", + "telegram": "@telegramUser", + "facebook": "facebookUser", + "reddit": "redditUser", + "twitter": "@twitterAccount" + } + ], + "required": [], + "additionalProperties": true, + "properties": { + "discord": { + "$id": "#/properties/contact/properties/social/properties/discord", + "type": "string", + "title": "discord user", + "description": ".", + "default": "", + "examples": [ + "discordUser#1234" + ] + }, + "telegram": { + "$id": "#/properties/contact/properties/social/properties/telegram", + "type": "string", + "title": "telegram user", + "description": ".", + "default": "", + "examples": [ + "@telegramUser" + ] + }, + "facebook": { + "$id": "#/properties/contact/properties/social/properties/facebook", + "type": "string", + "title": "facebook user", + "description": ".", + "default": "", + "examples": [ + "facebookUser" + ] + }, + "reddit": { + "$id": "#/properties/contact/properties/social/properties/reddit", + "type": "string", + "title": "reddit user", + "description": ".", + "default": "", + "examples": [ + "redditUser" + ] + }, + "twitter": { + "$id": "#/properties/contact/properties/social/properties/twitter", + "type": "string", + "title": "twitter account", + "description": ".", + "default": "", + "examples": [ + "@twitterAccount" + ] + } + } + } + } + }, + "CI": { + "$id": "#/properties/CI", + "type": "object", + "title": "The CI schema", + "description": "corporate identity and design", + "default": {}, + "examples": [ + { + "color-main": "#RRGGBB", + "logo-vector": "" + } + ], + "required": [], + "additionalProperties": true, + "properties": { + "color-main": { + "$id": "#/properties/CI/properties/color-main", + "type": "string", + "title": "RGB color", + "description": "main theme color", + "default": "", + "examples": [ + "#RRGGBB" + ] + }, + "logo-vector": { + "$id": "#/properties/CI/properties/logo-vector", + "type": "string", + "title": "vector logo", + "description": "svg defined vector logo", + "default": "", + "examples": [ + "" + ] + } + } + } + } +} +``` + + ## Backwards compatibility From 67adc31bdf2bea0cec5ec31db2db7969f9ad5288 Mon Sep 17 00:00:00 2001 From: mikefullman Date: Fri, 21 Aug 2020 23:54:02 -0700 Subject: [PATCH 03/11] WIP --- CIP6/CIP6.md | 858 ++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 715 insertions(+), 143 deletions(-) diff --git a/CIP6/CIP6.md b/CIP6/CIP6.md index 0741d92c0..a59684b0b 100644 --- a/CIP6/CIP6.md +++ b/CIP6/CIP6.md @@ -2,7 +2,7 @@ CIP: 6 Title: Extended Metadata Authors: Mike Fullman , Markus Gufler -Comments-URI: +Comments-URI: Status: Draft Type: Standards Created: 2020-07-20 @@ -40,19 +40,89 @@ We define one more line for the on chain referenced metadata file that reference | `extended` | A url for extended metadata| Optional, 64 Characters Maximum, must be a valid URL | #### Extended Metadata -The file located at the URL for extended data is a json compliant text file with the following fields: +The file located at the URL for extended data is a json compliant text file with the following top level fields: -| key | Value | Rules | -| --- | --- | --- | -| `serial` | set to YYYYMMDDxx on every update | regex: `\d{10}` | -| `itn.owner` | ITN pool public key | regex: `ed25519_pk1[a-z0-9]{58}` | -| `itn.witness` | Mainnet pool id signed by the ITN pool owner secret key | regex: `ed25519_sig1[a-z0-9]{109}` | +| key | Description | +| --- | --- | +| `serial` | set to YYYYMMDDxx on every update | +| `itn` | ITN pool validation data | +| `info` | Corporate image, contacts and about details | +| `pools` | Pool details | Since this extended metadata file has no checksum and can be updated at any time by the pool operator, a **serial number** is useful to easily identify updates. The purpose of this first (**itn**) extension is the verifiable linking of an ITN pool ticker with its counterpart in Mainnet to identify fraudulent duplicates. - +#### Complete Extended Metadata Example +``` +{ + "serial": 2020072001, + "itn": { + "owner": "ed25519_pk1...", + "witness": "ed25519_sig1..." + }, + "info": { + "CI": { + "logo_url_png_icon_64x64": "https://mycoolpool.com/icon.png", + "logo_url_png_logo": "https://mycoolpool.com/logo.png", + "color_main": "#RRGGBB", + "logo_vector": "" + }, + "social": { + "twitter_handle": "coolpool", + "telegram_handle": "coolpool", + "facebook_handle": "coolpool", + "youtube_handle": "coolpool", + "twitch_handle": "coolpool", + "discord_handle": "coolpool", + "github_handle": "coolpool" + }, + "contact": { + "abuse": "abuse@pooldomain.org", + "support": "help@pooldomain.org" + }, + "company": { + "name": "Company Name", + "addr": "Street, Number", + "city": "London", + "country": "UK", + "company_id": "123456789", + "vat_id": "GB123456789" + }, + "operator": { + "country": "UK", + "sex": "FEMALE" + }, + "about": { + "team_affiliation": [ + "ISPPA", + "Cardano Ambassador" + ], + "me": "Long description of me", + "server": "long description of server details", + "company": "long description of company details" + }, + "rss": "https://mycoolpool.com/xml/poolrss.xml" + }, + "pools": [{ + "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "country": "UK", + "os": "LINUX", + "infrastructure": "AWS", + "status": "act", + "saturated_recommend":"0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + }, + { + "id": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "country": "UK", + "os": "LINUX", + "infrastructure": "AWS", + "status": "act", + "saturated_recommend":"0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + } + ] +} +``` #### Extended Metadata Schema @@ -71,235 +141,737 @@ The purpose of this first (**itn**) extension is the verifiable linking of an IT "owner": "ed25519_pk1...", "witness": "ed25519_sig1..." }, - "contact": { - "abuse": "abuse@pooldomain.org", - "support": "help@pooldomain.org", + "info": { + "CI": { + "logo_url_png_icon_64x64": "https://mycoolpool.com/icon.png", + "logo_url_png_logo": "https://mycoolpool.com/logo.png", + "color_main": "#RRGGBB", + "logo_vector": "" + }, "social": { - "discord": "discordUser#1234", - "telegram": "@telegramUser", - "facebook": "facebookUser", - "reddit": "redditUser", - "twitter": "@twitterAccount" - } + "twitter_handle": "coolpool", + "telegram_handle": "coolpool", + "facebook_handle": "coolpool", + "youtube_handle": "coolpool", + "twitch_handle": "coolpool", + "discord_handle": "coolpool", + "github_handle": "coolpool" + }, + "contact": { + "abuse": "abuse@pooldomain.org", + "support": "help@pooldomain.org" + }, + "company": { + "name": "Company Name", + "addr": "Street, Number", + "city": "London", + "country": "UK", + "company_id": "123456789", + "vat_id": "GB123456789" + }, + "operator": { + "country": "UK", + "sex": "FEMALE" + }, + "about": { + "team_affiliation": [ + "ISPPA", + "Cardano Ambassador" + ], + "me": "Long description of me", + "server": "long description of server details", + "company": "long description of company details" + }, + "rss": "https://mycoolpool.com/xml/poolrss.xml" }, - "CI": { - "color-main": "#RRGGBB", - "logo-vector": "" - } + "pools": [ + { + "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "country": "UK", + "os": "LINUX", + "infrastructure": "AWS", + "status": "act", + "saturated_recommend": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + }, + { + "id": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "country": "UK", + "os": "LINUX", + "infrastructure": "AWS", + "status": "act", + "saturated_recommend": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + } + ] } ], "required": [ - "serial" + "serial", ], - "additionalProperties": true, "properties": { "serial": { - "$id": "#/properties/serial", - "type": "integer", - "title": "serial number", - "description": "YYYYMMDDxx set on every update", "default": 0, + "description": "YYYYMMDDxx set on every update", "examples": [ 2020072001 ], + "title": "Serial Number", "pattern": "`\\d{10}`" }, "itn": { - "$id": "#/properties/itn", - "type": "object", - "title": "ITN relations", - "description": "Link incentivised-testnet and mainnet tickers", "default": {}, + "description": "Link incentivised-testnet and mainnet tickers", "examples": [ { "owner": "ed25519_pk1...", "witness": "ed25519_sig1..." } ], - "required": [], - "additionalProperties": true, + "required": [ + "owner", + "witness" + ], + "title": "ITN relations", "properties": { "owner": { - "$id": "#/properties/itn/properties/owner", - "type": "string", - "title": "owner public key", - "description": "", "default": "", + "description": "Public key of ITN pool", "examples": [ "ed25519_pk1..." ], - "pattern": "`ed25519_pk1[a-z0-9]{58}`" + "title": "owner public key" }, "witness": { - "$id": "#/properties/itn/properties/witness", - "type": "string", - "title": "signed pool id", - "description": "Mainnet pool id signed by the ITN pool owner secret key", "default": "", + "description": "Mainnet pool id signed by the ITN pool owner secret key", "examples": [ "ed25519_sig1..." ], - "pattern": "`ed25519_sig1[a-z0-9]{109}`" + "title": "signed pool id" } - } + }, + "additionalProperties": true }, - "contact": { - "$id": "#/properties/contact", + "info": { + "$id": "#/properties/info", "type": "object", - "title": "The contact schema", - "description": "additional contact options", + "title": "The info schema", + "description": "An explanation about the purpose of this instance.", "default": {}, "examples": [ { - "abuse": "abuse@pooldomain.org", - "support": "help@pooldomain.org", + "CI": { + "logo_url_png_icon_64x64": "https://mycoolpool.com/icon.png", + "logo_url_png_logo": "https://mycoolpool.com/logo.png", + "color_main": "#RRGGBB", + "logo_vector": "" + }, "social": { - "discord": "discordUser#1234", - "telegram": "@telegramUser", - "facebook": "facebookUser", - "reddit": "redditUser", - "twitter": "@twitterAccount" - } + "twitter_handle": "coolpool", + "telegram_handle": "coolpool", + "facebook_handle": "coolpool", + "youtube_handle": "coolpool", + "twitch_handle": "coolpool", + "discord_handle": "coolpool", + "github_handle": "coolpool" + }, + "contact": { + "abuse": "abuse@pooldomain.org", + "support": "help@pooldomain.org" + }, + "company": { + "name": "Company Name", + "addr": "Street, Number", + "city": "London", + "country": "UK", + "company_id": "123456789", + "vat_id": "GB123456789" + }, + "operator": { + "country": "UK", + "sex": "FEMALE" + }, + "about": { + "team_affiliation": [ + "ISPPA", + "Cardano Ambassador" + ], + "me": "Long description of me", + "server": "long description of server details", + "company": "long description of company details" + }, + "rss": "https://mycoolpool.com/xml/poolrss.xml" } ], - "required": [], - "additionalProperties": true, "properties": { - "abuse": { - "$id": "#/properties/contact/properties/abuse", - "type": "string", - "title": "abuse contact", - "description": "email address", - "default": "", + "CI": { + "default": {}, + "description": "All details related to corporate image", "examples": [ - "abuse@pooldomain.org" - ] + { + "logo_url_png_icon_64x64": "https://mycoolpool.com/icon.png", + "logo_url_png_logo": "https://mycoolpool.com/logo.png", + "color_main": "#RRGGBB", + "logo_vector": "" + } + ], + "title": "Corporate Image Details", + "properties": { + "logo_url_png_icon_64x64": { + "default": "", + "description": "A small logo, 64x64 max size", + "examples": [ + "https://mycoolpool.com/icon.png" + ], + "pattern": "https?://(?:[a-z0-9\\-]+\\.)+[a-z]{2,6}(?:/[^/#?]+)+\\.png$", + "title": "The logo_url_png_icon_64x64" + }, + "logo_url_png_logo": { + "default": "", + "description": "A pool logo", + "examples": [ + "https://mycoolpool.com/logo.png" + ], + "pattern": "https?://(?:[a-z0-9\\-]+\\.)+[a-z]{2,6}(?:/[^/#?]+)+\\.png$", + "title": "A url to a pool logo" + }, + "color_main": { + "default": "", + "description": "HTML RGB color code with corporate background theme color", + "examples": [ + "#RRGGBB" + ], + "title": "Background color", + "pattern": "^[0-9a-fA-F]{6}$" + }, + "logo_vector": { + "default": "", + "description": "svg defined vector logo", + "examples": [ + "" + ], + "title": "vector logo" + } + }, + "additionalProperties": true }, - "support": { - "$id": "#/properties/contact/properties/support", - "type": "string", - "title": "support contact", - "description": "email address", - "default": "", + "social": { + "$id": "#/properties/info/properties/social", + "type": "object", + "title": "The social schema", + "description": "An explanation about the purpose of this instance.", + "default": {}, "examples": [ - "help@pooldomain.org" - ] + { + "twitter_handle": "coolpool", + "telegram_handle": "coolpool", + "facebook_handle": "coolpool", + "youtube_handle": "coolpool", + "twitch_handle": "coolpool", + "discord_handle": "coolpool", + "github_handle": "coolpool" + } + ], + + "properties": { + "twitter_handle": { + "default": "", + "description": "Twitter handle without leading @", + "examples": [ + "coolpool" + ], + "title": "The twitter_handle schema", + "pattern": "^(\\w){1,15}$" + }, + "telegram_handle": { + "default": "", + "description": "An explanation about the purpose of this instance.", + "examples": [ + "coolpool" + ], + "title": "The telegram_handle schema" + + }, + "facebook_handle": { + "default": "", + "description": "An explanation about the purpose of this instance.", + "examples": [ + "coolpool" + ], + "title": "The facebook_handle schema", + "pattern": "^(\\w){1,55}$" + }, + "youtube_handle": { + "$id": "#/properties/info/properties/social/properties/youtube_handle", + "type": "string", + "title": "The youtube_handle schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "coolpool" + ] + }, + "twitch_handle": { + "$id": "#/properties/info/properties/social/properties/twitch_handle", + "type": "string", + "title": "The twitch_handle schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "coolpool" + ] + }, + "discord_handle": { + "$id": "#/properties/info/properties/social/properties/discord_handle", + "type": "string", + "title": "The discord_handle schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "coolpool" + ] + }, + "github_handle": { + "$id": "#/properties/info/properties/social/properties/github_handle", + "type": "string", + "title": "The github_handle schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "coolpool" + ] + } + }, + "additionalProperties": true }, - "social": { - "$id": "#/properties/contact/properties/social", + "contact": { + "$id": "#/properties/info/properties/contact", + "type": "object", + "title": "The contact schema", + "description": "An explanation about the purpose of this instance.", + "default": {}, + "examples": [ + { + "abuse": "abuse@pooldomain.org", + "support": "help@pooldomain.org" + } + ], + + "properties": { + "abuse": { + "default": "", + "description": "Abuse contact email", + "examples": [ + "abuse@pooldomain.org" + ], + "title": "Abuse Contact email" + }, + "support": { + "default": "", + "description": "Support contact email", + "examples": [ + "help@pooldomain.org" + ], + "title": "Support Contact Email" + } + }, + "additionalProperties": true + }, + "company": { + "$id": "#/properties/info/properties/company", "type": "object", - "title": "social channels", - "description": "optional social channels.", + "title": "Company Details", + "description": "Contact details of company", "default": {}, "examples": [ { - "discord": "discordUser#1234", - "telegram": "@telegramUser", - "facebook": "facebookUser", - "reddit": "redditUser", - "twitter": "@twitterAccount" + "name": "Company Name", + "addr": "Street, Number", + "city": "London", + "country": "UK", + "company_id": "123456789", + "vat_id": "GB123456789" } ], - "required": [], - "additionalProperties": true, "properties": { - "discord": { - "$id": "#/properties/contact/properties/social/properties/discord", + "name": { + "$id": "#/properties/info/properties/company/properties/name", "type": "string", - "title": "discord user", - "description": ".", + "title": "Company Name", + "description": "Company Name.", "default": "", "examples": [ - "discordUser#1234" + "Company Name" ] }, - "telegram": { - "$id": "#/properties/contact/properties/social/properties/telegram", + "addr": { + "$id": "#/properties/info/properties/company/properties/addr", "type": "string", - "title": "telegram user", - "description": ".", + "title": "Company ddress", + "description": "Company ddress", "default": "", "examples": [ - "@telegramUser" + "5534 HappyPool Lane" ] }, - "facebook": { - "$id": "#/properties/contact/properties/social/properties/facebook", + "city": { + "$id": "#/properties/info/properties/company/properties/city", "type": "string", - "title": "facebook user", - "description": ".", + "title": "Company City", + "description": "Company City", "default": "", "examples": [ - "facebookUser" + "London" ] }, - "reddit": { - "$id": "#/properties/contact/properties/social/properties/reddit", + "country": { + "$id": "#/properties/info/properties/company/properties/country", "type": "string", - "title": "reddit user", - "description": ".", + "title": "Company Country", + "description": "ISO 3166-2 2-letter country code", "default": "", "examples": [ - "redditUser" + "UK" ] }, - "twitter": { - "$id": "#/properties/contact/properties/social/properties/twitter", + "company_id": { + "$id": "#/properties/info/properties/company/properties/company_id", "type": "string", - "title": "twitter account", - "description": ".", + "title": "company id", + "description": "company id", "default": "", "examples": [ - "@twitterAccount" + "123456789" + ] + }, + "vat_id": { + "$id": "#/properties/info/properties/company/properties/vat_id", + "type": "string", + "title": "company vat id", + "description": "company vat id", + "default": "", + "examples": [ + "GB123456789" ] } - } - } - } - }, - "CI": { - "$id": "#/properties/CI", - "type": "object", - "title": "The CI schema", - "description": "corporate identity and design", - "default": {}, - "examples": [ - { - "color-main": "#RRGGBB", - "logo-vector": "" - } - ], - "required": [], - "additionalProperties": true, - "properties": { - "color-main": { - "$id": "#/properties/CI/properties/color-main", - "type": "string", - "title": "RGB color", - "description": "main theme color", - "default": "", + }, + "additionalProperties": true + }, + "operator": { + "$id": "#/properties/info/properties/operator", + "type": "object", + "title": "The operator schema", + "description": "An explanation about the purpose of this instance.", + "default": {}, "examples": [ - "#RRGGBB" - ] + { + "country": "UK", + "sex": "0" + } + ], + "required": [ + "country", + "sex" + ], + "properties": { + "country": { + "$id": "#/properties/info/properties/operator/properties/country", + "type": "string", + "title": "The country schema", + "description": "ISO 3166-2 2-letter country code", + "default": "", + "examples": [ + "UK" + ] + }, + "sex": { + "$id": "#/properties/info/properties/operator/properties/sex", + "type": "string", + "title": "The sex schema", + "description": "ISO/IEC 5218 sex", + "default": "", + "examples": [ + "1" + ] + } + }, + "additionalProperties": true + }, + "about": { + "$id": "#/properties/info/properties/about", + "type": "object", + "title": "The about schema", + "description": "An explanation about the purpose of this instance.", + "default": {}, + "examples": [ + { + "team_affiliation": [ + "ISPPA", + "Cardano Ambassador" + ], + "me": "Long description of me", + "server": "long description of server details", + "company": "long description of company details" + } + ], + "properties": { + "team_affiliation": { + "$id": "#/properties/info/properties/about/properties/team_affiliation", + "type": "array", + "title": "Team Affiliations", + "description": "Case insensitive affiliations. Matching performed on entire string.", + "default": [], + "examples": [ + [ + "ISPPA", + "Cardano Ambassador" + ] + ], + "additionalItems": true, + "items": { + "$id": "#/properties/info/properties/about/properties/team_affiliation/items", + "anyOf": [ + { + "$id": "#/properties/info/properties/about/properties/team_affiliation/items/anyOf/0", + "type": "string", + "title": "Team Name", + "description": "Case insensitive affiliations. Matching performed on entire string.", + "default": "", + "examples": [ + "ISPPA", + "Cardano Ambassador" + ] + } + ] + } + }, + "me": { + "$id": "#/properties/info/properties/about/properties/me", + "type": "string", + "title": "Long Description Me", + "description": "Long Description. valid HTML tags are


", + "default": "", + "examples": [ + "Long description of me" + ] + }, + "server": { + "$id": "#/properties/info/properties/about/properties/server", + "type": "string", + "title": "Long Description Server", + "description": "Long Description. valid HTML tags are


", + "default": "", + "examples": [ + "long description of server details" + ] + }, + "company": { + "$id": "#/properties/info/properties/about/properties/company", + "type": "string", + "title": "Long Description Company", + "description": "Long Description. valid HTML tags are


", + "default": "", + "examples": [ + "long description of company details" + ] + } + }, + "additionalProperties": true }, - "logo-vector": { - "$id": "#/properties/CI/properties/logo-vector", + "rss": { + "$id": "#/properties/info/properties/rss", "type": "string", - "title": "vector logo", - "description": "svg defined vector logo", + "title": "Rss Feed", + "description": "URL to an RSS feed", "default": "", "examples": [ - "" + "https://mycoolpool.com/xml/poolrss.xml" ] } + }, + "additionalProperties": true + }, + "pools": { + "$id": "#/properties/pools", + "type": "array", + "title": "Pool List", + "description": "Long Description.", + "default": [], + "examples": [ + [ + { + "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "country": "UK", + "os": "LINUX", + "infrastructure": "AWS", + "status": "act", + "saturated_recommend": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + }, + { + "id": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "country": "UK", + "os": "LINUX", + "infrastructure": "AWS", + "status": "act", + "saturated_recommend": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + } + ] + ], + "additionalItems": true, + "items": { + "$id": "#/properties/pools/items", + "anyOf": [ + { + "$id": "#/properties/pools/items/anyOf/0", + "type": "object", + "title": "Pool", + "description": "", + "default": {}, + "examples": [ + { + "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "country": "UK", + "os": "LINUX", + "infrastructure": "AWS", + "status": "act", + "saturated_recommend": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + } + ], + "required": [ + "id", + ], + "properties": { + "id": { + "$id": "#/properties/pools/items/anyOf/0/properties/id", + "type": "string", + "title": "The poolid", + "description": "Valid Mainnet Pool Id (hex format)", + "default": "", + "examples": [ + "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + ] + }, + "country": { + "$id": "#/properties/pools/items/anyOf/0/properties/country", + "type": "string", + "title": "Pool country", + "description": "ISO 3166-2 2-letter country code", + "default": "", + "examples": [ + "UK" + ] + }, + "os": { + "$id": "#/properties/pools/items/anyOf/0/properties/os", + "type": "string", + "title": "Pool Operating System", + "description": "Pool Operating System", + "default": "", + "examples": [ + "LINUX", + "OSX", + "WIN", + "FREEBSD", + "UNDISCLOSED" + ] + }, + "infrastructure": { + "$id": "#/properties/pools/items/anyOf/0/properties/infrastructure", + "type": "string", + "title": "Pool Infrastructure", + "description": "Pool infrastructure Platform", + "default": "", + "examples": [ + "AWS", + "GOOGLE", + "AZURE", + "DIGITALOCEAN", + "BAREMETALL", + "BAREMETALH", + "OVH", + "HETZNER", + "VULTR", + "GODADDY", + "ARUBA", + "HOSTINGER", + "OTHERVPS", + "LPCSBC", + "UNDISCLOSED" + ] + }, + "status": { + "$id": "#/properties/pools/items/anyOf/0/properties/status", + "type": "string", + "title": "Pool Status", + "description": "Pool Current Status", + "default": "", + "examples": [ + "ACT","RET","OFF","EXP","DNU" + ] + }, + "saturated_recommend": { + "$id": "#/properties/pools/items/anyOf/0/properties/saturated_recommend", + "type": "string", + "title": "Saturated Recommend", + "description": "If the pool is saturated recommend this pool", + "default": "", + "examples": [ + "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + ] + } + }, + "additionalProperties": true + } + ] } } - } + }, + "additionalProperties": true } ``` +## Infrastructure Mapping +``` +[ + {"Code": "aws", "Name": "Amazon Cloud"}, + {"Code": "google", "Name": "Google Cloud"}, + {"Code": "azure", "Name": "Microsoft Cloud"}, + {"Code": "digitalocean", "Name": "Digital Ocean"}, + {"Code": "baremetall", "Name": "Bare Metal Server(local)"}, + {"Code": "baremetalh", "Name": "Bare Metal Server(hosted)"}, + {"Code": "ovh", "Name": "OVH Cloud"}, + {"Code": "hetzner", "Name": "Hetzner"}, + {"Code": "vultr", "Name": "Vultr"}, + {"Code": "godaddy", "Name": "Go Daddy"}, + {"Code": "aruba", "Name": "Aruba"}, + {"Code": "hostinger", "Name": "Hostinger"}, + {"Code": "othervps", "Name": "Other VPS"}, + {"Code": "lpcsbc", "Name": "Low Power/Cost SBC (pi, rockspi, etc)"}, + {"Code": "undisclosed", "Name": "Undisclosed"} +] +``` + +## Operating System Mapping +``` +[ + {"Code": "linux", "Name": "Linux"}, + {"Code": "osx", "Name": "Apple OSX"}, + {"Code": "win", "Name": "Windows"}, + {"Code": "freebsd", "Name": "FreeBSD"}, + {"Code": "undisclosed", "Name": "Undisclosed"} +] +``` +## Pool Status Mapping +``` +[ + {"Code": "act","Name": "Active"}, + {"Code": "ret","Name": "Retired"}, + {"Code": "off","Name": "Offline for Maintenance"}, + {"Code": "exp","Name": "Experimental"}, + {"Code": "dnu","Name": "Do Not Delegate To This Pool"} +] +``` ## Backwards compatibility No fields are removed or changed in the current on chain metadata. The new field `extended` is optional and not necessary to parse for any entities that do not need additional information about a pool From dedf07e08a900dc2dbf6e494b7e47feabc042ac8 Mon Sep 17 00:00:00 2001 From: mikefullman Date: Mon, 7 Sep 2020 22:01:56 -0700 Subject: [PATCH 04/11] move schema to separate file, update based on round 1 feedback --- CIP6/CIP6.md | 708 +---------------------------------------------- CIP6/schema.json | 698 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 701 insertions(+), 705 deletions(-) create mode 100644 CIP6/schema.json diff --git a/CIP6/CIP6.md b/CIP6/CIP6.md index a59684b0b..747b42ed7 100644 --- a/CIP6/CIP6.md +++ b/CIP6/CIP6.md @@ -66,7 +66,7 @@ The purpose of this first (**itn**) extension is the verifiable linking of an IT "logo_url_png_icon_64x64": "https://mycoolpool.com/icon.png", "logo_url_png_logo": "https://mycoolpool.com/logo.png", "color_main": "#RRGGBB", - "logo_vector": "" + "logo_vector": "https://mycoolpool.com/logo.svg" }, "social": { "twitter_handle": "coolpool", @@ -91,7 +91,7 @@ The purpose of this first (**itn**) extension is the verifiable linking of an IT }, "operator": { "country": "UK", - "sex": "FEMALE" + "sex": "2" }, "about": { "team_affiliation": [ @@ -126,709 +126,7 @@ The purpose of this first (**itn**) extension is the verifiable linking of an IT #### Extended Metadata Schema -``` -{ - "$schema": "http://json-schema.org/draft-07/schema", - "$id": "http://example.com/example.json", - "type": "object", - "title": "The root schema", - "description": "The root schema comprises the entire JSON document.", - "default": {}, - "examples": [ - { - "serial": 2020072001, - "itn": { - "owner": "ed25519_pk1...", - "witness": "ed25519_sig1..." - }, - "info": { - "CI": { - "logo_url_png_icon_64x64": "https://mycoolpool.com/icon.png", - "logo_url_png_logo": "https://mycoolpool.com/logo.png", - "color_main": "#RRGGBB", - "logo_vector": "" - }, - "social": { - "twitter_handle": "coolpool", - "telegram_handle": "coolpool", - "facebook_handle": "coolpool", - "youtube_handle": "coolpool", - "twitch_handle": "coolpool", - "discord_handle": "coolpool", - "github_handle": "coolpool" - }, - "contact": { - "abuse": "abuse@pooldomain.org", - "support": "help@pooldomain.org" - }, - "company": { - "name": "Company Name", - "addr": "Street, Number", - "city": "London", - "country": "UK", - "company_id": "123456789", - "vat_id": "GB123456789" - }, - "operator": { - "country": "UK", - "sex": "FEMALE" - }, - "about": { - "team_affiliation": [ - "ISPPA", - "Cardano Ambassador" - ], - "me": "Long description of me", - "server": "long description of server details", - "company": "long description of company details" - }, - "rss": "https://mycoolpool.com/xml/poolrss.xml" - }, - "pools": [ - { - "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", - "country": "UK", - "os": "LINUX", - "infrastructure": "AWS", - "status": "act", - "saturated_recommend": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" - }, - { - "id": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", - "country": "UK", - "os": "LINUX", - "infrastructure": "AWS", - "status": "act", - "saturated_recommend": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" - } - ] - } - ], - "required": [ - "serial", - ], - "properties": { - "serial": { - "default": 0, - "description": "YYYYMMDDxx set on every update", - "examples": [ - 2020072001 - ], - "title": "Serial Number", - "pattern": "`\\d{10}`" - }, - "itn": { - "default": {}, - "description": "Link incentivised-testnet and mainnet tickers", - "examples": [ - { - "owner": "ed25519_pk1...", - "witness": "ed25519_sig1..." - } - ], - "required": [ - "owner", - "witness" - ], - "title": "ITN relations", - "properties": { - "owner": { - "default": "", - "description": "Public key of ITN pool", - "examples": [ - "ed25519_pk1..." - ], - "title": "owner public key" - }, - "witness": { - "default": "", - "description": "Mainnet pool id signed by the ITN pool owner secret key", - "examples": [ - "ed25519_sig1..." - ], - "title": "signed pool id" - } - }, - "additionalProperties": true - }, - "info": { - "$id": "#/properties/info", - "type": "object", - "title": "The info schema", - "description": "An explanation about the purpose of this instance.", - "default": {}, - "examples": [ - { - "CI": { - "logo_url_png_icon_64x64": "https://mycoolpool.com/icon.png", - "logo_url_png_logo": "https://mycoolpool.com/logo.png", - "color_main": "#RRGGBB", - "logo_vector": "" - }, - "social": { - "twitter_handle": "coolpool", - "telegram_handle": "coolpool", - "facebook_handle": "coolpool", - "youtube_handle": "coolpool", - "twitch_handle": "coolpool", - "discord_handle": "coolpool", - "github_handle": "coolpool" - }, - "contact": { - "abuse": "abuse@pooldomain.org", - "support": "help@pooldomain.org" - }, - "company": { - "name": "Company Name", - "addr": "Street, Number", - "city": "London", - "country": "UK", - "company_id": "123456789", - "vat_id": "GB123456789" - }, - "operator": { - "country": "UK", - "sex": "FEMALE" - }, - "about": { - "team_affiliation": [ - "ISPPA", - "Cardano Ambassador" - ], - "me": "Long description of me", - "server": "long description of server details", - "company": "long description of company details" - }, - "rss": "https://mycoolpool.com/xml/poolrss.xml" - } - ], - "properties": { - "CI": { - "default": {}, - "description": "All details related to corporate image", - "examples": [ - { - "logo_url_png_icon_64x64": "https://mycoolpool.com/icon.png", - "logo_url_png_logo": "https://mycoolpool.com/logo.png", - "color_main": "#RRGGBB", - "logo_vector": "" - } - ], - "title": "Corporate Image Details", - "properties": { - "logo_url_png_icon_64x64": { - "default": "", - "description": "A small logo, 64x64 max size", - "examples": [ - "https://mycoolpool.com/icon.png" - ], - "pattern": "https?://(?:[a-z0-9\\-]+\\.)+[a-z]{2,6}(?:/[^/#?]+)+\\.png$", - "title": "The logo_url_png_icon_64x64" - }, - "logo_url_png_logo": { - "default": "", - "description": "A pool logo", - "examples": [ - "https://mycoolpool.com/logo.png" - ], - "pattern": "https?://(?:[a-z0-9\\-]+\\.)+[a-z]{2,6}(?:/[^/#?]+)+\\.png$", - "title": "A url to a pool logo" - }, - "color_main": { - "default": "", - "description": "HTML RGB color code with corporate background theme color", - "examples": [ - "#RRGGBB" - ], - "title": "Background color", - "pattern": "^[0-9a-fA-F]{6}$" - }, - "logo_vector": { - "default": "", - "description": "svg defined vector logo", - "examples": [ - "" - ], - "title": "vector logo" - } - }, - "additionalProperties": true - }, - "social": { - "$id": "#/properties/info/properties/social", - "type": "object", - "title": "The social schema", - "description": "An explanation about the purpose of this instance.", - "default": {}, - "examples": [ - { - "twitter_handle": "coolpool", - "telegram_handle": "coolpool", - "facebook_handle": "coolpool", - "youtube_handle": "coolpool", - "twitch_handle": "coolpool", - "discord_handle": "coolpool", - "github_handle": "coolpool" - } - ], - - "properties": { - "twitter_handle": { - "default": "", - "description": "Twitter handle without leading @", - "examples": [ - "coolpool" - ], - "title": "The twitter_handle schema", - "pattern": "^(\\w){1,15}$" - }, - "telegram_handle": { - "default": "", - "description": "An explanation about the purpose of this instance.", - "examples": [ - "coolpool" - ], - "title": "The telegram_handle schema" - - }, - "facebook_handle": { - "default": "", - "description": "An explanation about the purpose of this instance.", - "examples": [ - "coolpool" - ], - "title": "The facebook_handle schema", - "pattern": "^(\\w){1,55}$" - }, - "youtube_handle": { - "$id": "#/properties/info/properties/social/properties/youtube_handle", - "type": "string", - "title": "The youtube_handle schema", - "description": "An explanation about the purpose of this instance.", - "default": "", - "examples": [ - "coolpool" - ] - }, - "twitch_handle": { - "$id": "#/properties/info/properties/social/properties/twitch_handle", - "type": "string", - "title": "The twitch_handle schema", - "description": "An explanation about the purpose of this instance.", - "default": "", - "examples": [ - "coolpool" - ] - }, - "discord_handle": { - "$id": "#/properties/info/properties/social/properties/discord_handle", - "type": "string", - "title": "The discord_handle schema", - "description": "An explanation about the purpose of this instance.", - "default": "", - "examples": [ - "coolpool" - ] - }, - "github_handle": { - "$id": "#/properties/info/properties/social/properties/github_handle", - "type": "string", - "title": "The github_handle schema", - "description": "An explanation about the purpose of this instance.", - "default": "", - "examples": [ - "coolpool" - ] - } - }, - "additionalProperties": true - }, - "contact": { - "$id": "#/properties/info/properties/contact", - "type": "object", - "title": "The contact schema", - "description": "An explanation about the purpose of this instance.", - "default": {}, - "examples": [ - { - "abuse": "abuse@pooldomain.org", - "support": "help@pooldomain.org" - } - ], - - "properties": { - "abuse": { - "default": "", - "description": "Abuse contact email", - "examples": [ - "abuse@pooldomain.org" - ], - "title": "Abuse Contact email" - }, - "support": { - "default": "", - "description": "Support contact email", - "examples": [ - "help@pooldomain.org" - ], - "title": "Support Contact Email" - } - }, - "additionalProperties": true - }, - "company": { - "$id": "#/properties/info/properties/company", - "type": "object", - "title": "Company Details", - "description": "Contact details of company", - "default": {}, - "examples": [ - { - "name": "Company Name", - "addr": "Street, Number", - "city": "London", - "country": "UK", - "company_id": "123456789", - "vat_id": "GB123456789" - } - ], - "properties": { - "name": { - "$id": "#/properties/info/properties/company/properties/name", - "type": "string", - "title": "Company Name", - "description": "Company Name.", - "default": "", - "examples": [ - "Company Name" - ] - }, - "addr": { - "$id": "#/properties/info/properties/company/properties/addr", - "type": "string", - "title": "Company ddress", - "description": "Company ddress", - "default": "", - "examples": [ - "5534 HappyPool Lane" - ] - }, - "city": { - "$id": "#/properties/info/properties/company/properties/city", - "type": "string", - "title": "Company City", - "description": "Company City", - "default": "", - "examples": [ - "London" - ] - }, - "country": { - "$id": "#/properties/info/properties/company/properties/country", - "type": "string", - "title": "Company Country", - "description": "ISO 3166-2 2-letter country code", - "default": "", - "examples": [ - "UK" - ] - }, - "company_id": { - "$id": "#/properties/info/properties/company/properties/company_id", - "type": "string", - "title": "company id", - "description": "company id", - "default": "", - "examples": [ - "123456789" - ] - }, - "vat_id": { - "$id": "#/properties/info/properties/company/properties/vat_id", - "type": "string", - "title": "company vat id", - "description": "company vat id", - "default": "", - "examples": [ - "GB123456789" - ] - } - }, - "additionalProperties": true - }, - "operator": { - "$id": "#/properties/info/properties/operator", - "type": "object", - "title": "The operator schema", - "description": "An explanation about the purpose of this instance.", - "default": {}, - "examples": [ - { - "country": "UK", - "sex": "0" - } - ], - "required": [ - "country", - "sex" - ], - "properties": { - "country": { - "$id": "#/properties/info/properties/operator/properties/country", - "type": "string", - "title": "The country schema", - "description": "ISO 3166-2 2-letter country code", - "default": "", - "examples": [ - "UK" - ] - }, - "sex": { - "$id": "#/properties/info/properties/operator/properties/sex", - "type": "string", - "title": "The sex schema", - "description": "ISO/IEC 5218 sex", - "default": "", - "examples": [ - "1" - ] - } - }, - "additionalProperties": true - }, - "about": { - "$id": "#/properties/info/properties/about", - "type": "object", - "title": "The about schema", - "description": "An explanation about the purpose of this instance.", - "default": {}, - "examples": [ - { - "team_affiliation": [ - "ISPPA", - "Cardano Ambassador" - ], - "me": "Long description of me", - "server": "long description of server details", - "company": "long description of company details" - } - ], - "properties": { - "team_affiliation": { - "$id": "#/properties/info/properties/about/properties/team_affiliation", - "type": "array", - "title": "Team Affiliations", - "description": "Case insensitive affiliations. Matching performed on entire string.", - "default": [], - "examples": [ - [ - "ISPPA", - "Cardano Ambassador" - ] - ], - "additionalItems": true, - "items": { - "$id": "#/properties/info/properties/about/properties/team_affiliation/items", - "anyOf": [ - { - "$id": "#/properties/info/properties/about/properties/team_affiliation/items/anyOf/0", - "type": "string", - "title": "Team Name", - "description": "Case insensitive affiliations. Matching performed on entire string.", - "default": "", - "examples": [ - "ISPPA", - "Cardano Ambassador" - ] - } - ] - } - }, - "me": { - "$id": "#/properties/info/properties/about/properties/me", - "type": "string", - "title": "Long Description Me", - "description": "Long Description. valid HTML tags are


", - "default": "", - "examples": [ - "Long description of me" - ] - }, - "server": { - "$id": "#/properties/info/properties/about/properties/server", - "type": "string", - "title": "Long Description Server", - "description": "Long Description. valid HTML tags are


", - "default": "", - "examples": [ - "long description of server details" - ] - }, - "company": { - "$id": "#/properties/info/properties/about/properties/company", - "type": "string", - "title": "Long Description Company", - "description": "Long Description. valid HTML tags are


", - "default": "", - "examples": [ - "long description of company details" - ] - } - }, - "additionalProperties": true - }, - "rss": { - "$id": "#/properties/info/properties/rss", - "type": "string", - "title": "Rss Feed", - "description": "URL to an RSS feed", - "default": "", - "examples": [ - "https://mycoolpool.com/xml/poolrss.xml" - ] - } - }, - "additionalProperties": true - }, - "pools": { - "$id": "#/properties/pools", - "type": "array", - "title": "Pool List", - "description": "Long Description.", - "default": [], - "examples": [ - [ - { - "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", - "country": "UK", - "os": "LINUX", - "infrastructure": "AWS", - "status": "act", - "saturated_recommend": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" - }, - { - "id": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", - "country": "UK", - "os": "LINUX", - "infrastructure": "AWS", - "status": "act", - "saturated_recommend": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" - } - ] - ], - "additionalItems": true, - "items": { - "$id": "#/properties/pools/items", - "anyOf": [ - { - "$id": "#/properties/pools/items/anyOf/0", - "type": "object", - "title": "Pool", - "description": "", - "default": {}, - "examples": [ - { - "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", - "country": "UK", - "os": "LINUX", - "infrastructure": "AWS", - "status": "act", - "saturated_recommend": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" - } - ], - "required": [ - "id", - ], - "properties": { - "id": { - "$id": "#/properties/pools/items/anyOf/0/properties/id", - "type": "string", - "title": "The poolid", - "description": "Valid Mainnet Pool Id (hex format)", - "default": "", - "examples": [ - "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" - ] - }, - "country": { - "$id": "#/properties/pools/items/anyOf/0/properties/country", - "type": "string", - "title": "Pool country", - "description": "ISO 3166-2 2-letter country code", - "default": "", - "examples": [ - "UK" - ] - }, - "os": { - "$id": "#/properties/pools/items/anyOf/0/properties/os", - "type": "string", - "title": "Pool Operating System", - "description": "Pool Operating System", - "default": "", - "examples": [ - "LINUX", - "OSX", - "WIN", - "FREEBSD", - "UNDISCLOSED" - ] - }, - "infrastructure": { - "$id": "#/properties/pools/items/anyOf/0/properties/infrastructure", - "type": "string", - "title": "Pool Infrastructure", - "description": "Pool infrastructure Platform", - "default": "", - "examples": [ - "AWS", - "GOOGLE", - "AZURE", - "DIGITALOCEAN", - "BAREMETALL", - "BAREMETALH", - "OVH", - "HETZNER", - "VULTR", - "GODADDY", - "ARUBA", - "HOSTINGER", - "OTHERVPS", - "LPCSBC", - "UNDISCLOSED" - ] - }, - "status": { - "$id": "#/properties/pools/items/anyOf/0/properties/status", - "type": "string", - "title": "Pool Status", - "description": "Pool Current Status", - "default": "", - "examples": [ - "ACT","RET","OFF","EXP","DNU" - ] - }, - "saturated_recommend": { - "$id": "#/properties/pools/items/anyOf/0/properties/saturated_recommend", - "type": "string", - "title": "Saturated Recommend", - "description": "If the pool is saturated recommend this pool", - "default": "", - "examples": [ - "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" - ] - } - }, - "additionalProperties": true - } - ] - } - } - }, - "additionalProperties": true -} -``` - +see incorporated file [schema.json](schema.json) ## Infrastructure Mapping ``` diff --git a/CIP6/schema.json b/CIP6/schema.json new file mode 100644 index 000000000..5436ba50c --- /dev/null +++ b/CIP6/schema.json @@ -0,0 +1,698 @@ +{ + "$schema": "http://json-schema.org/draft-07/schema", + "$id": "http://example.com/example.json", + "type": "object", + "title": "The root schema", + "description": "The root schema comprises the entire JSON document.", + "default": {}, + "examples": [ + { + "serial": 2020072001, + "itn": { + "owner": "ed25519_pk1...", + "witness": "ed25519_sig1..." + }, + "info": { + "CI": { + "logo_url_png_icon_64x64": "https://mycoolpool.com/icon.png", + "logo_url_png_logo": "https://mycoolpool.com/logo.png", + "color_main": "#RRGGBB", + "logo_vector": "https://mycoolpool.com/logo.svg" + }, + "social": { + "twitter_handle": "coolpool", + "telegram_handle": "coolpool", + "facebook_handle": "coolpool", + "youtube_handle": "coolpool", + "twitch_handle": "coolpool", + "discord_handle": "coolpool", + "github_handle": "coolpool" + }, + "contact": { + "abuse": "abuse@pooldomain.org", + "support": "help@pooldomain.org" + }, + "company": { + "name": "Company Name", + "addr": "Street, Number", + "city": "London", + "country": "UK", + "company_id": "123456789", + "vat_id": "GB123456789" + }, + "operator": { + "country": "UK", + "sex": "2" + }, + "about": { + "team_affiliation": [ + "ISPPA", + "Cardano Ambassador" + ], + "me": "Long description of me", + "server": "long description of server details", + "company": "long description of company details" + }, + "rss": "https://mycoolpool.com/xml/poolrss.xml" + }, + "pools": [ + { + "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "country": "UK", + "os": "LINUX", + "infrastructure": "AWS", + "status": "act", + "saturated_recommend": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + }, + { + "id": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "country": "UK", + "os": "LINUX", + "infrastructure": "AWS", + "status": "act", + "saturated_recommend": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + } + ] + } + ], + "required": [ + "serial" + ], + "properties": { + "serial": { + "default": 0, + "description": "YYYYMMDDxx set on every update", + "examples": [ + 2020072001 + ], + "title": "Serial Number", + "pattern": "`\\d{10}`" + }, + "itn": { + "default": {}, + "description": "Link incentivised-testnet and mainnet tickers", + "examples": [ + { + "owner": "ed25519_pk1...", + "witness": "ed25519_sig1..." + } + ], + "required": [ + "owner", + "witness" + ], + "title": "ITN relations", + "properties": { + "owner": { + "default": "", + "description": "Public key of ITN pool", + "examples": [ + "ed25519_pk1..." + ], + "title": "owner public key" + }, + "witness": { + "default": "", + "description": "Mainnet pool id signed by the ITN pool owner secret key", + "examples": [ + "ed25519_sig1..." + ], + "title": "signed pool id" + } + }, + "additionalProperties": true + }, + "info": { + "$id": "#/properties/info", + "type": "object", + "title": "The info schema", + "description": "An explanation about the purpose of this instance.", + "default": {}, + "examples": [ + { + "CI": { + "logo_url_png_icon_64x64": "https://mycoolpool.com/icon.png", + "logo_url_png_logo": "https://mycoolpool.com/logo.png", + "color_main": "#RRGGBB", + "logo_vector": "https://mycoolpool.com/logo.svg" + }, + "social": { + "twitter_handle": "coolpool", + "telegram_handle": "coolpool", + "facebook_handle": "coolpool", + "youtube_handle": "coolpool", + "twitch_handle": "coolpool", + "discord_handle": "coolpool", + "github_handle": "coolpool" + }, + "contact": { + "abuse": "abuse@pooldomain.org", + "support": "help@pooldomain.org" + }, + "company": { + "name": "Company Name", + "addr": "Street, Number", + "city": "London", + "country": "UK", + "company_id": "123456789", + "vat_id": "GB123456789" + }, + "operator": { + "country": "UK", + "sex": "2" + }, + "about": { + "team_affiliation": [ + "ISPPA", + "Cardano Ambassador" + ], + "me": "Long description of me", + "server": "long description of server details", + "company": "long description of company details" + }, + "rss": "https://mycoolpool.com/xml/poolrss.xml" + } + ], + "properties": { + "CI": { + "default": {}, + "description": "All details related to corporate image", + "examples": [ + { + "logo_url_png_icon_64x64": "https://mycoolpool.com/icon.png", + "logo_url_png_logo": "https://mycoolpool.com/logo.png", + "color_main": "#RRGGBB", + "logo_vector": "https://mycoolpool.com/logo.svg" + } + ], + "title": "Corporate Image Details", + "properties": { + "logo_url_png_icon_64x64": { + "default": "", + "description": "A small logo, 64x64 max size", + "examples": [ + "https://mycoolpool.com/icon.png" + ], + "pattern": "https?://(?:[a-z0-9\\-]+\\.)+[a-z]{2,6}(?:/[^/#?]+)+\\.png$", + "title": "The logo_url_png_icon_64x64" + }, + "logo_url_png_logo": { + "default": "", + "description": "A pool logo", + "examples": [ + "https://mycoolpool.com/logo.png" + ], + "pattern": "https?://(?:[a-z0-9\\-]+\\.)+[a-z]{2,6}(?:/[^/#?]+)+\\.png$", + "title": "A url to a pool logo" + }, + "color_main": { + "default": "", + "description": "HTML RGB color code with corporate background theme color", + "examples": [ + "#RRGGBB" + ], + "title": "Background color", + "pattern": "^[0-9a-fA-F]{6}$" + }, + "logo_vector": { + "default": "", + "description": "svg defined vector logo", + "pattern": "https?://(?:[a-z0-9\\-]+\\.)+[a-z]{2,6}(?:/[^/#?]+)+\\.svg$", + "examples": [ + "https://mycoolpool.com/logo.svg" + ], + "title": "vector logo" + } + }, + "additionalProperties": true + }, + "social": { + "$id": "#/properties/info/properties/social", + "type": "object", + "title": "The social schema", + "description": "An explanation about the purpose of this instance.", + "default": {}, + "examples": [ + { + "twitter_handle": "coolpool", + "telegram_handle": "coolpool", + "facebook_handle": "coolpool", + "youtube_handle": "coolpool", + "twitch_handle": "coolpool", + "discord_handle": "coolpool", + "github_handle": "coolpool" + } + ], + + "properties": { + "twitter_handle": { + "default": "", + "description": "Twitter handle without leading @", + "examples": [ + "coolpool" + ], + "title": "The twitter_handle schema", + "pattern": "^(\\w){1,15}$" + }, + "telegram_handle": { + "default": "", + "description": "An explanation about the purpose of this instance.", + "examples": [ + "coolpool" + ], + "title": "The telegram_handle schema" + + }, + "facebook_handle": { + "default": "", + "description": "An explanation about the purpose of this instance.", + "examples": [ + "coolpool" + ], + "title": "The facebook_handle schema", + "pattern": "^(\\w){1,55}$" + }, + "youtube_handle": { + "$id": "#/properties/info/properties/social/properties/youtube_handle", + "type": "string", + "title": "The youtube_handle schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "coolpool" + ] + }, + "twitch_handle": { + "$id": "#/properties/info/properties/social/properties/twitch_handle", + "type": "string", + "title": "The twitch_handle schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "coolpool" + ] + }, + "discord_handle": { + "$id": "#/properties/info/properties/social/properties/discord_handle", + "type": "string", + "title": "The discord_handle schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "coolpool" + ] + }, + "github_handle": { + "$id": "#/properties/info/properties/social/properties/github_handle", + "type": "string", + "title": "The github_handle schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "coolpool" + ] + } + }, + "additionalProperties": true + }, + "contact": { + "$id": "#/properties/info/properties/contact", + "type": "object", + "title": "The contact schema", + "description": "An explanation about the purpose of this instance.", + "default": {}, + "examples": [ + { + "abuse": "abuse@pooldomain.org", + "support": "help@pooldomain.org" + } + ], + + "properties": { + "abuse": { + "default": "", + "description": "Abuse contact email", + "examples": [ + "abuse@pooldomain.org" + ], + "title": "Abuse Contact email" + }, + "support": { + "default": "", + "description": "Support contact email", + "examples": [ + "help@pooldomain.org" + ], + "title": "Support Contact Email" + } + }, + "additionalProperties": true + }, + "company": { + "$id": "#/properties/info/properties/company", + "type": "object", + "title": "Company Details", + "description": "Contact details of company", + "default": {}, + "examples": [ + { + "name": "Company Name", + "addr": "Street, Number", + "city": "London", + "country": "UK", + "company_id": "123456789", + "vat_id": "GB123456789" + } + ], + "properties": { + "name": { + "$id": "#/properties/info/properties/company/properties/name", + "type": "string", + "title": "Company Name", + "description": "Company Name.", + "default": "", + "examples": [ + "Company Name" + ] + }, + "addr": { + "$id": "#/properties/info/properties/company/properties/addr", + "type": "string", + "title": "Company ddress", + "description": "Company ddress", + "default": "", + "examples": [ + "5534 HappyPool Lane" + ] + }, + "city": { + "$id": "#/properties/info/properties/company/properties/city", + "type": "string", + "title": "Company City", + "description": "Company City", + "default": "", + "examples": [ + "London" + ] + }, + "country": { + "$id": "#/properties/info/properties/company/properties/country", + "type": "string", + "title": "Company Country", + "description": "ISO 3166-2 2-letter country code", + "default": "", + "examples": [ + "UK" + ] + }, + "company_id": { + "$id": "#/properties/info/properties/company/properties/company_id", + "type": "string", + "title": "company id", + "description": "company id", + "default": "", + "examples": [ + "123456789" + ] + }, + "vat_id": { + "$id": "#/properties/info/properties/company/properties/vat_id", + "type": "string", + "title": "company vat id", + "description": "company vat id", + "default": "", + "examples": [ + "GB123456789" + ] + } + }, + "additionalProperties": true + }, + "operator": { + "$id": "#/properties/info/properties/operator", + "type": "object", + "title": "The operator schema", + "description": "An explanation about the purpose of this instance.", + "default": {}, + "examples": [ + { + "country": "UK", + "sex": "0" + } + ], + + "properties": { + "country": { + "$id": "#/properties/info/properties/operator/properties/country", + "type": "string", + "title": "The country schema", + "description": "ISO 3166-2 2-letter country code", + "default": "", + "examples": [ + "UK" + ] + }, + "sex": { + "$id": "#/properties/info/properties/operator/properties/sex", + "type": "string", + "title": "The sex schema", + "description": "ISO/IEC 5218 sex", + "default": "", + "examples": [ + "1" + ] + } + }, + "additionalProperties": true + }, + "about": { + "$id": "#/properties/info/properties/about", + "type": "object", + "title": "The about schema", + "description": "An explanation about the purpose of this instance.", + "default": {}, + "examples": [ + { + "team_affiliation": [ + "ISPPA", + "Cardano Ambassador" + ], + "me": "Long description of me", + "server": "long description of server details", + "company": "long description of company details" + } + ], + "properties": { + "team_affiliation": { + "$id": "#/properties/info/properties/about/properties/team_affiliation", + "type": "array", + "title": "Team Affiliations", + "description": "Case insensitive affiliations. Matching performed on entire string.", + "default": [], + "examples": [ + [ + "ISPPA", + "Cardano Ambassador" + ] + ], + "additionalItems": true, + "items": { + "$id": "#/properties/info/properties/about/properties/team_affiliation/items", + "anyOf": [ + { + "$id": "#/properties/info/properties/about/properties/team_affiliation/items/anyOf/0", + "type": "string", + "title": "Team Name", + "description": "Case insensitive affiliations. Matching performed on entire string.", + "default": "", + "examples": [ + "ISPPA", + "Cardano Ambassador" + ] + } + ] + } + }, + "me": { + "$id": "#/properties/info/properties/about/properties/me", + "type": "string", + "title": "Long Description Me", + "description": "Long Description. valid HTML tags are


", + "default": "", + "examples": [ + "Long description of me" + ] + }, + "server": { + "$id": "#/properties/info/properties/about/properties/server", + "type": "string", + "title": "Long Description Server", + "description": "Long Description. valid HTML tags are


", + "default": "", + "examples": [ + "long description of server details" + ] + }, + "company": { + "$id": "#/properties/info/properties/about/properties/company", + "type": "string", + "title": "Long Description Company", + "description": "Long Description. valid HTML tags are


", + "default": "", + "examples": [ + "long description of company details" + ] + } + }, + "additionalProperties": true + }, + "rss": { + "$id": "#/properties/info/properties/rss", + "type": "string", + "title": "Rss Feed", + "description": "URL to an RSS feed", + "default": "", + "examples": [ + "https://mycoolpool.com/xml/poolrss.xml" + ] + } + }, + "additionalProperties": true + }, + "pools": { + "$id": "#/properties/pools", + "type": "array", + "title": "Pool List", + "description": "Long Description.", + "default": [], + "examples": [ + [ + { + "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "country": "UK", + "os": "LINUX", + "infrastructure": "AWS", + "status": "act", + "saturated_recommend": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + }, + { + "id": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "country": "UK", + "os": "LINUX", + "infrastructure": "AWS", + "status": "act", + "saturated_recommend": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + } + ] + ], + "additionalItems": true, + "items": { + "$id": "#/properties/pools/items", + "anyOf": [ + { + "$id": "#/properties/pools/items/anyOf/0", + "type": "object", + "title": "Pool", + "description": "", + "default": {}, + "examples": [ + { + "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "country": "UK", + "os": "LINUX", + "infrastructure": "AWS", + "status": "act", + "saturated_recommend": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + } + ], + "required": [ + "id" + ], + "properties": { + "id": { + "$id": "#/properties/pools/items/anyOf/0/properties/id", + "type": "string", + "title": "The poolid", + "description": "Valid Mainnet Pool Id (hex format)", + "default": "", + "examples": [ + "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + ] + }, + "country": { + "$id": "#/properties/pools/items/anyOf/0/properties/country", + "type": "string", + "title": "Pool country", + "description": "ISO 3166-2 2-letter country code", + "default": "", + "examples": [ + "UK" + ] + }, + "os": { + "$id": "#/properties/pools/items/anyOf/0/properties/os", + "type": "string", + "title": "Pool Operating System", + "description": "Pool Operating System", + "default": "", + "examples": [ + "LINUX", + "OSX", + "WIN", + "FREEBSD", + "UNDISCLOSED" + ] + }, + "infrastructure": { + "$id": "#/properties/pools/items/anyOf/0/properties/infrastructure", + "type": "string", + "title": "Pool Infrastructure", + "description": "Pool infrastructure Platform", + "default": "", + "examples": [ + "AWS", + "GOOGLE", + "AZURE", + "DIGITALOCEAN", + "BAREMETALL", + "BAREMETALH", + "OVH", + "HETZNER", + "VULTR", + "GODADDY", + "ARUBA", + "HOSTINGER", + "OTHERVPS", + "LPCSBC", + "UNDISCLOSED" + ] + }, + "status": { + "$id": "#/properties/pools/items/anyOf/0/properties/status", + "type": "string", + "title": "Pool Status", + "description": "Pool Current Status", + "default": "", + "examples": [ + "ACT","RET","OFF","EXP","DNU" + ] + }, + "saturated_recommend": { + "$id": "#/properties/pools/items/anyOf/0/properties/saturated_recommend", + "type": "string", + "title": "Saturated Recommend", + "description": "If the pool is saturated recommend this pool", + "default": "", + "examples": [ + "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + ] + } + }, + "additionalProperties": true + } + ] + } + } + }, + "additionalProperties": true +} \ No newline at end of file From 4aa9cf27643fdcc78c80a524d08d40bd8de6cad7 Mon Sep 17 00:00:00 2001 From: mikefullman Date: Mon, 7 Sep 2020 22:28:51 -0700 Subject: [PATCH 05/11] add appropriate license reference. Add pool to root rather than pools. add admin telegram back in. --- CIP6/CIP6.md | 33 ++-- CIP6/LICENSE | 395 +++++++++++++++++++++++++++++++++++++++++++++++ CIP6/schema.json | 269 ++++++++++++++------------------ 3 files changed, 528 insertions(+), 169 deletions(-) create mode 100644 CIP6/LICENSE diff --git a/CIP6/CIP6.md b/CIP6/CIP6.md index 747b42ed7..abb17dd8e 100644 --- a/CIP6/CIP6.md +++ b/CIP6/CIP6.md @@ -6,7 +6,7 @@ Comments-URI: Status: Draft Type: Standards Created: 2020-07-20 -License: Apache-2.0 +License: CC-BY-4.0 --- ## Abstract @@ -79,7 +79,8 @@ The purpose of this first (**itn**) extension is the verifiable linking of an IT }, "contact": { "abuse": "abuse@pooldomain.org", - "support": "help@pooldomain.org" + "support": "help@pooldomain.org", + "telegram_admin":"coolpool" }, "company": { "name": "Company Name", @@ -104,23 +105,15 @@ The purpose of this first (**itn**) extension is the verifiable linking of an IT }, "rss": "https://mycoolpool.com/xml/poolrss.xml" }, - "pools": [{ - "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", - "country": "UK", - "os": "LINUX", - "infrastructure": "AWS", - "status": "act", - "saturated_recommend":"0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" - }, - { - "id": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", - "country": "UK", - "os": "LINUX", - "infrastructure": "AWS", - "status": "act", - "saturated_recommend":"0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" - } - ] + "pool": { + "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "country": "UK", + "os": "LINUX", + "infrastructure": "AWS", + "status": "act", + "saturated_recommend":"0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + } + } ``` @@ -180,4 +173,4 @@ N/A ## Copyright -This CIP is licensed under Apache-2.0. +This file is documentation, and therefore subject to CC-BY-4.0 (and not subject to Apache 2.0). diff --git a/CIP6/LICENSE b/CIP6/LICENSE new file mode 100644 index 000000000..f987f3daa --- /dev/null +++ b/CIP6/LICENSE @@ -0,0 +1,395 @@ +Attribution 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution 4.0 International Public License ("Public License"). To the +extent this Public License may be interpreted as a contract, You are +granted the Licensed Rights in consideration of Your acceptance of +these terms and conditions, and the Licensor grants You such rights in +consideration of benefits the Licensor receives from making the +Licensed Material available under these terms and conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + d. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + e. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + f. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + g. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + h. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + i. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + j. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + k. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + 4. If You Share Adapted Material You produce, the Adapter's + License You apply must not prevent recipients of the Adapted + Material from complying with this Public License. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material; and + + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public licenses. +Notwithstanding, Creative Commons may elect to apply one of its public +licenses to material it publishes and in those instances will be +considered the “Licensor.” The text of the Creative Commons public +licenses is dedicated to the public domain under the CC0 Public Domain +Dedication. Except for the limited purpose of indicating that material +is shared under a Creative Commons public license or as otherwise +permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the public +licenses. + +Creative Commons may be contacted at creativecommons.org. \ No newline at end of file diff --git a/CIP6/schema.json b/CIP6/schema.json index 5436ba50c..abd8036c9 100644 --- a/CIP6/schema.json +++ b/CIP6/schema.json @@ -55,24 +55,16 @@ }, "rss": "https://mycoolpool.com/xml/poolrss.xml" }, - "pools": [ - { - "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", - "country": "UK", - "os": "LINUX", - "infrastructure": "AWS", - "status": "act", - "saturated_recommend": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" - }, - { - "id": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", - "country": "UK", - "os": "LINUX", - "infrastructure": "AWS", - "status": "act", - "saturated_recommend": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" - } - ] + "pool": { + "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "country": "UK", + "os": "LINUX", + "infrastructure": "AWS", + "status": "act", + "saturated_recommend": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + } + + } ], "required": [ @@ -324,7 +316,8 @@ "examples": [ { "abuse": "abuse@pooldomain.org", - "support": "help@pooldomain.org" + "support": "help@pooldomain.org", + "telegram_admin":"coolpool" } ], @@ -344,6 +337,15 @@ "help@pooldomain.org" ], "title": "Support Contact Email" + }, + "telegram_admin": { + "default": "", + "description": "The administrator telegram contact handle", + "examples": [ + "coolpool" + ], + "title": "he administrator telegram contact handle" + } }, "additionalProperties": true @@ -559,139 +561,108 @@ }, "additionalProperties": true }, - "pools": { + "pool": { "$id": "#/properties/pools", - "type": "array", - "title": "Pool List", - "description": "Long Description.", - "default": [], + "type": "object", + "title": "Pool Details", + "description": "All pool details.", + "default": {}, "examples": [ - [ - { - "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", - "country": "UK", - "os": "LINUX", - "infrastructure": "AWS", - "status": "act", - "saturated_recommend": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" - }, - { - "id": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", - "country": "UK", - "os": "LINUX", - "infrastructure": "AWS", - "status": "act", - "saturated_recommend": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" - } - ] + { + "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "country": "UK", + "os": "LINUX", + "infrastructure": "AWS", + "status": "act", + "saturated_recommend": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + } + ], - "additionalItems": true, - "items": { - "$id": "#/properties/pools/items", - "anyOf": [ - { - "$id": "#/properties/pools/items/anyOf/0", - "type": "object", - "title": "Pool", - "description": "", - "default": {}, - "examples": [ - { - "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", - "country": "UK", - "os": "LINUX", - "infrastructure": "AWS", - "status": "act", - "saturated_recommend": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" - } - ], - "required": [ - "id" - ], - "properties": { - "id": { - "$id": "#/properties/pools/items/anyOf/0/properties/id", - "type": "string", - "title": "The poolid", - "description": "Valid Mainnet Pool Id (hex format)", - "default": "", - "examples": [ - "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" - ] - }, - "country": { - "$id": "#/properties/pools/items/anyOf/0/properties/country", - "type": "string", - "title": "Pool country", - "description": "ISO 3166-2 2-letter country code", - "default": "", - "examples": [ - "UK" - ] - }, - "os": { - "$id": "#/properties/pools/items/anyOf/0/properties/os", - "type": "string", - "title": "Pool Operating System", - "description": "Pool Operating System", - "default": "", - "examples": [ - "LINUX", - "OSX", - "WIN", - "FREEBSD", - "UNDISCLOSED" - ] - }, - "infrastructure": { - "$id": "#/properties/pools/items/anyOf/0/properties/infrastructure", - "type": "string", - "title": "Pool Infrastructure", - "description": "Pool infrastructure Platform", - "default": "", - "examples": [ - "AWS", - "GOOGLE", - "AZURE", - "DIGITALOCEAN", - "BAREMETALL", - "BAREMETALH", - "OVH", - "HETZNER", - "VULTR", - "GODADDY", - "ARUBA", - "HOSTINGER", - "OTHERVPS", - "LPCSBC", - "UNDISCLOSED" - ] - }, - "status": { - "$id": "#/properties/pools/items/anyOf/0/properties/status", - "type": "string", - "title": "Pool Status", - "description": "Pool Current Status", - "default": "", - "examples": [ - "ACT","RET","OFF","EXP","DNU" - ] - }, - "saturated_recommend": { - "$id": "#/properties/pools/items/anyOf/0/properties/saturated_recommend", - "type": "string", - "title": "Saturated Recommend", - "description": "If the pool is saturated recommend this pool", - "default": "", - "examples": [ - "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" - ] - } - }, - "additionalProperties": true - } - ] - } + "required": [ + "id" + ], + + "properties": { + "id": { + "$id": "#/properties/pools/items/anyOf/0/properties/id", + "type": "string", + "title": "The poolid", + "description": "Valid Mainnet Pool Id (hex format)", + "default": "", + "examples": [ + "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + ] + }, + "country": { + "$id": "#/properties/pools/items/anyOf/0/properties/country", + "type": "string", + "title": "Pool country", + "description": "ISO 3166-2 2-letter country code", + "default": "", + "examples": [ + "UK" + ] + }, + "os": { + "$id": "#/properties/pools/items/anyOf/0/properties/os", + "type": "string", + "title": "Pool Operating System", + "description": "Pool Operating System", + "default": "", + "examples": [ + "LINUX", + "OSX", + "WIN", + "FREEBSD", + "UNDISCLOSED" + ] + }, + "infrastructure": { + "$id": "#/properties/pools/items/anyOf/0/properties/infrastructure", + "type": "string", + "title": "Pool Infrastructure", + "description": "Pool infrastructure Platform", + "default": "", + "examples": [ + "AWS", + "GOOGLE", + "AZURE", + "DIGITALOCEAN", + "BAREMETALL", + "BAREMETALH", + "OVH", + "HETZNER", + "VULTR", + "GODADDY", + "ARUBA", + "HOSTINGER", + "OTHERVPS", + "LPCSBC", + "UNDISCLOSED" + ] + }, + "status": { + "$id": "#/properties/pools/items/anyOf/0/properties/status", + "type": "string", + "title": "Pool Status", + "description": "Pool Current Status", + "default": "", + "examples": [ + "ACT","RET","OFF","EXP","DNU" + ] + }, + "saturated_recommend": { + "$id": "#/properties/pools/items/anyOf/0/properties/saturated_recommend", + "type": "string", + "title": "Saturated Recommend", + "description": "If the pool is saturated recommend this pool", + "default": "", + "examples": [ + "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + ] + } + }, + "additionalProperties": true } }, "additionalProperties": true From b53da370108a8fde1b13dd4e1abb61e37b109e60 Mon Sep 17 00:00:00 2001 From: Markus Date: Tue, 1 Dec 2020 09:48:46 +0100 Subject: [PATCH 06/11] 2nd key-pair for validation --- CIP6/CIP6.md | 143 ++--- CIP6/schema.json | 1445 ++++++++++++++++++++++++++++++++-------------- 2 files changed, 1071 insertions(+), 517 deletions(-) diff --git a/CIP6/CIP6.md b/CIP6/CIP6.md index abb17dd8e..1ae9f00a7 100644 --- a/CIP6/CIP6.md +++ b/CIP6/CIP6.md @@ -1,11 +1,12 @@ --- CIP: 6 Title: Extended Metadata -Authors: Mike Fullman , Markus Gufler +Authors: Markus Gufler , Mike Fullman Comments-URI: Status: Draft Type: Standards -Created: 2020-07-20 +Created: 2020-07-20 original draft +Updated: 2020-11-24 2nd key-pair for validation License: CC-BY-4.0 --- @@ -28,8 +29,8 @@ Many additional attributes can be envisioned for future wallets, pool explorers, ## Specification -#### On Chain referenced metadata file -We define one more line for the on chain referenced metadata file that references another json file on a url with the extended metadata. The proposed metadata is as follows: +### On Chain referenced (main) metadata file +We define two more fields for the on chain referenced metadata file that references another json file on a url with the extended metadata. The proposed metadata is as follows: | key | Value | Rules | | --- | --- | --- | @@ -37,91 +38,71 @@ We define one more line for the on chain referenced metadata file that reference | `description` | Pool Description. Text that describes the pool | 50 Characters Maximum | | `homepage` | A website URL for the pool| 64 Characters Maximum, must be a valid URL | | `name` | A name for the pool | 50 Characters Maximum | -| `extended` | A url for extended metadata| Optional, 64 Characters Maximum, must be a valid URL | +| `extDataUrl` | A URL for extended metadata | optional, 128 Characters Maximum, must be a valid URL | +| `extHashUrl` | A URL with the extended metadata hash | optional, 128 Characters Maximum, must be a valid URL | +| `extVkey` | the public Key for verification | optional, 68 Characters | -#### Extended Metadata -The file located at the URL for extended data is a json compliant text file with the following top level fields: +In order to include the additional ext Field data, we suggest increasing the maximum size of the main metadata file from currently 512 to 1024 bytes. -| key | Description | -| --- | --- | -| `serial` | set to YYYYMMDDxx on every update | -| `itn` | ITN pool validation data | -| `info` | Corporate image, contacts and about details | -| `pools` | Pool details | +### Extended Metadata - flexible but validable -Since this extended metadata file has no checksum and can be updated at any time by the pool operator, a **serial number** is useful to easily identify updates. +In difference to the main metadata, the extended metadata should be updateable without having to use the cold key of the pool and without having to perform an on-chain transaction. The consumer of these data should still have the possibility to verify the authenticity of the data. -The purpose of this first (**itn**) extension is the verifiable linking of an ITN pool ticker with its counterpart in Mainnet to identify fraudulent duplicates. +The operator notes all his additional pool information in the extended metadata (`extData.json`). -#### Complete Extended Metadata Example +We propose the pool operator generate a new public-secret key-pair (`extData.skey` and `extData.vkey`) + +```shell +cardano-cli shelley node key-gen + --cold-verification-key-file extData.vkey + --cold-signing-key-file extData.skey + --operational-certificate-issue-counter-file extData.counter ``` -{ - "serial": 2020072001, - "itn": { - "owner": "ed25519_pk1...", - "witness": "ed25519_sig1..." - }, - "info": { - "CI": { - "logo_url_png_icon_64x64": "https://mycoolpool.com/icon.png", - "logo_url_png_logo": "https://mycoolpool.com/logo.png", - "color_main": "#RRGGBB", - "logo_vector": "https://mycoolpool.com/logo.svg" - }, - "social": { - "twitter_handle": "coolpool", - "telegram_handle": "coolpool", - "facebook_handle": "coolpool", - "youtube_handle": "coolpool", - "twitch_handle": "coolpool", - "discord_handle": "coolpool", - "github_handle": "coolpool" - }, - "contact": { - "abuse": "abuse@pooldomain.org", - "support": "help@pooldomain.org", - "telegram_admin":"coolpool" - }, - "company": { - "name": "Company Name", - "addr": "Street, Number", - "city": "London", - "country": "UK", - "company_id": "123456789", - "vat_id": "GB123456789" - }, - "operator": { - "country": "UK", - "sex": "2" - }, - "about": { - "team_affiliation": [ - "ISPPA", - "Cardano Ambassador" - ], - "me": "Long description of me", - "server": "long description of server details", - "company": "long description of company details" - }, - "rss": "https://mycoolpool.com/xml/poolrss.xml" - }, - "pool": { - "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", - "country": "UK", - "os": "LINUX", - "infrastructure": "AWS", - "status": "act", - "saturated_recommend":"0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" - } - -} + +Then a new (not available yet) `cardano-cli` command generate the signed hash (`extData.sign`) . + +```shell +cardano-cli shelley stake-pool rawdata-hash + --raw-metadata-file extData.json + --signing-key-file extData.skey + --out-file extData.sign ``` +The operator now: + +- has the `extData.json` and `extData.sign` files +- will publish them at some https:// URL (probably same host as the main metadata) +- use the `extData.vkey` string and the two extend file URLs to re-register the main metadata + +This re-registration of the main metadata file with the `extData.vkey` and the two URLs is only necessary once. Afterwards, the operator can update his extended metadata at any time, generate the new signature and put both files online. + +### Extended Metadata structure + +In the following we describe a first minimal version of the extended Json file format + +Since this extended metadata file can be updated at any time by the pool operator, a **serial number** is useful to easily identify updates. + +There are main thematic sections with respective subordinate data fields: + +- the **itn** section is about the verifiable linking of an ITN pool ticker with its counterpart in Mainnet to identify fraudulent duplicates. (already used as not standardized extension) +- the **pool** section contains additional information about the pool instance +- the **operator** section contains additional information about the people operating this pool +- the **owner** section contains additional information about the pool owner(s) + + + +ToDo: describe the initial basic format, and a standard on how future CIPs need to approach an evolution of the extended metadata schema + + + #### Extended Metadata Schema +``` +work in progress +``` + -see incorporated file [schema.json](schema.json) -## Infrastructure Mapping +#### Infrastructure Mapping ``` [ {"Code": "aws", "Name": "Amazon Cloud"}, @@ -142,7 +123,7 @@ see incorporated file [schema.json](schema.json) ] ``` -## Operating System Mapping +#### Operating System Mapping ``` [ {"Code": "linux", "Name": "Linux"}, @@ -153,7 +134,7 @@ see incorporated file [schema.json](schema.json) ] ``` -## Pool Status Mapping +#### Pool Status Mapping ``` [ {"Code": "act","Name": "Active"}, @@ -165,7 +146,7 @@ see incorporated file [schema.json](schema.json) ``` ## Backwards compatibility -No fields are removed or changed in the current on chain metadata. The new field `extended` is optional and not necessary to parse for any entities that do not need additional information about a pool +No fields are removed or changed in the current on chain metadata. The new `ext...` fields are optional and not necessary to parse for any entities that do not need additional information about a pool ## Reference implementation diff --git a/CIP6/schema.json b/CIP6/schema.json index abd8036c9..1d2bb014b 100644 --- a/CIP6/schema.json +++ b/CIP6/schema.json @@ -1,665 +1,1238 @@ { - "$schema": "http://json-schema.org/draft-07/schema", "$id": "http://example.com/example.json", - "type": "object", - "title": "The root schema", - "description": "The root schema comprises the entire JSON document.", + "$schema": "http://json-schema.org/draft-07/schema", "default": {}, + "description": "additional information for Cardano Stake Pools", "examples": [ { "serial": 2020072001, - "itn": { - "owner": "ed25519_pk1...", - "witness": "ed25519_sig1..." - }, - "info": { - "CI": { - "logo_url_png_icon_64x64": "https://mycoolpool.com/icon.png", - "logo_url_png_logo": "https://mycoolpool.com/logo.png", - "color_main": "#RRGGBB", - "logo_vector": "https://mycoolpool.com/logo.svg" + "pool": { + "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "country": "DE", + "status": "act", + "saturated_recommend_id": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "contact": { + "primary": "email", + "discord": "coolpool", + "email": "help@pooldomain.org", + "facebook": "coolpool", + "github": "coolpool", + "phone_call": "+44 123456789", + "phone_text": "+44 123456789", + "feed": "https://mycoolpool.com/xml/poolrss.xml", + "telegram": "coolpool", + "telegram_channel": "https://t.me/coolchannel", + "twitch": "coolpool", + "twitter": "coolpool", + "youtube": "coolpool" }, - "social": { - "twitter_handle": "coolpool", - "telegram_handle": "coolpool", - "facebook_handle": "coolpool", - "youtube_handle": "coolpool", - "twitch_handle": "coolpool", - "discord_handle": "coolpool", - "github_handle": "coolpool" + "technology": { + "description": "We have a high availability setup with 2 block producers and 4 relays in 2 different data centers.", + "os": { + "$id": "#/properties/pools/items/anyOf/0/properties/os", + "type": "string", + "title": "Pool Operating System", + "description": "Pool Operating System", + "default": "", + "examples": [ + "Linux", + "macOS", + "Windows", + "BSD", + "Other", + "Undisclosed" + ] + }, + "infrastructure": { + "$id": "#/properties/pools/items/anyOf/0/properties/infrastructure", + "type": "string", + "title": "Pool Infrastructure", + "description": "Pool infrastructure Platform", + "default": "", + "examples": [ + "cloud", + "hosted bare metal", + "local bare metal", + "other", + "undisclosed" + ] + } }, - "contact": { - "abuse": "abuse@pooldomain.org", - "support": "help@pooldomain.org" + "media_assets": { + "icon_png_64x64": "https://mycoolpool.com/icon.png", + "logo_png": "https://mycoolpool.com/logo.png", + "logo_svg": "https://mycoolpool.com/logo.svg", + "color_fg": "#RRGGBB", + "color_bg": "#RRGGBB" }, - "company": { - "name": "Company Name", - "addr": "Street, Number", + "affiliations": [ + "ISPPA", + "Cardano Ambassador" + ], + "supporting": [ + "10% of fees donated to Save the Frogs.", + "Some proceeds used to sponsor local Cardano meetup." + ], + "itn": { + "owner": "ed25519_pk1...", + "witness": "ed25519_sig1..." + } + }, + "operator": { + "description": "Cool Ops operates pools for people.", + "person": { + "name": "Juanita Lopez", + "address": "101 Main St., Suite 3", "city": "London", + "state_or_region": "", + "postal_code": "123456", "country": "UK", - "company_id": "123456789", - "vat_id": "GB123456789" - }, - "operator": { - "country": "UK", - "sex": "2" - }, - "about": { - "team_affiliation": [ - "ISPPA", - "Cardano Ambassador" - ], - "me": "Long description of me", - "server": "long description of server details", - "company": "long description of company details" + "gender": "2" }, - "rss": "https://mycoolpool.com/xml/poolrss.xml" + "organization": { + "name": "Cool Ops LLC", + "government_id": "123456789", + "vat_id": "GB123456789", + "address": "101 Main St.", + "city": "London", + "state_or_region": "", + "postal_code": "123456", + "country": "UK" + } }, - "pool": { - "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", - "country": "UK", - "os": "LINUX", - "infrastructure": "AWS", - "status": "act", - "saturated_recommend": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + "owner": { + "description": "I am a podcaster and believer in Cardano.", + "person": { + "name": "Ramesh Patel", + "address": "", + "city": "Vancouver", + "state_or_region": "BC", + "postal_code": "", + "country": "CA", + "gender": "1" + } } - - } ], "required": [ - "serial" + "serial", + "pool" ], + "title": "Extended metadata", + "maxLength": 4096, + "type": "object", "properties": { "serial": { + "$id": "#/properties/serial", "default": 0, - "description": "YYYYMMDDxx set on every update", + "description": "Integer number incremented on every update, by using YYYYMMDDxx (xx each day start by 01 and is incremented on each update", "examples": [ 2020072001 ], - "title": "Serial Number", - "pattern": "`\\d{10}`" + "title": "serial number", + "maxLength": 10, + "minLength": 10, + "required": [], + "type": "integer" }, - "itn": { + "pool": { + "$id": "#/properties/pool", "default": {}, - "description": "Link incentivised-testnet and mainnet tickers", + "description": "pool related metadata", "examples": [ { - "owner": "ed25519_pk1...", - "witness": "ed25519_sig1..." + "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "country": "DE", + "status": "act", + "saturated_recommend_id": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "contact": { + "primary": "email", + "discord": "coolpool", + "email": "help@pooldomain.org", + "facebook": "coolpool", + "github": "coolpool", + "phone_call": "+44 123456789", + "phone_text": "+44 123456789", + "feed": "https://mycoolpool.com/xml/poolrss.xml", + "telegram": "coolpool", + "telegram_channel": "https://t.me/coolchannel", + "twitch": "coolpool", + "twitter": "coolpool", + "youtube": "coolpool" + }, + "technology": { + "description": "We have a high availability setup with 2 block producers and 4 relays in 2 different data centers.", + "os": { + "$id": "#/properties/pools/items/anyOf/0/properties/os", + "type": "string", + "title": "Pool Operating System", + "description": "Pool Operating System", + "default": "", + "examples": [ + "Linux", + "macOS", + "Windows", + "BSD", + "Other", + "Undisclosed" + ] + }, + "infrastructure": { + "$id": "#/properties/pools/items/anyOf/0/properties/infrastructure", + "type": "string", + "title": "Pool Infrastructure", + "description": "Pool infrastructure Platform", + "default": "", + "examples": [ + "cloud", + "hosted bare metal", + "local bare metal", + "other", + "undisclosed" + ] + } + }, + "media_assets": { + "icon_png_64x64": "https://mycoolpool.com/icon.png", + "logo_png": "https://mycoolpool.com/logo.png", + "logo_svg": "https://mycoolpool.com/logo.svg", + "color_fg": "#RRGGBB", + "color_bg": "#RRGGBB" + }, + "affiliations": [ + "ISPPA", + "Cardano Ambassador" + ], + "supporting": [ + "10% of fees donated to Save the Frogs.", + "Some proceeds used to sponsor local Cardano meetup." + ], + "itn": { + "owner": "ed25519_pk1...", + "witness": "ed25519_sig1..." + } } ], "required": [ - "owner", - "witness" + "id" ], - "title": "ITN relations", + "title": "stake pool", + "type": "object", "properties": { - "owner": { + "id": { + "$id": "#/properties/pool/properties/id", + "type": "string", + "title": "The id schema", + "description": "An explanation about the purpose of this instance.", "default": "", - "description": "Public key of ITN pool", "examples": [ - "ed25519_pk1..." - ], - "title": "owner public key" + "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + ] + }, + "country": { + "$id": "#/properties/pool/properties/country", + "type": "string", + "title": "The country schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "DE" + ] }, - "witness": { + "status": { + "$id": "#/properties/pool/properties/status", + "type": "string", + "title": "The status schema", + "description": "An explanation about the purpose of this instance.", "default": "", - "description": "Mainnet pool id signed by the ITN pool owner secret key", "examples": [ - "ed25519_sig1..." + "act" + ] + }, + "saturated_recommend_id": { + "$id": "#/properties/pool/properties/saturated_recommend_id", + "default": "", + "description": "An explanation about the purpose of this instance.", + "examples": [ + "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" ], - "title": "signed pool id" - } - }, - "additionalProperties": true - }, - "info": { - "$id": "#/properties/info", - "type": "object", - "title": "The info schema", - "description": "An explanation about the purpose of this instance.", - "default": {}, - "examples": [ - { - "CI": { - "logo_url_png_icon_64x64": "https://mycoolpool.com/icon.png", - "logo_url_png_logo": "https://mycoolpool.com/logo.png", - "color_main": "#RRGGBB", - "logo_vector": "https://mycoolpool.com/logo.svg" - }, - "social": { - "twitter_handle": "coolpool", - "telegram_handle": "coolpool", - "facebook_handle": "coolpool", - "youtube_handle": "coolpool", - "twitch_handle": "coolpool", - "discord_handle": "coolpool", - "github_handle": "coolpool" - }, - "contact": { - "abuse": "abuse@pooldomain.org", - "support": "help@pooldomain.org" - }, - "company": { - "name": "Company Name", - "addr": "Street, Number", - "city": "London", - "country": "UK", - "company_id": "123456789", - "vat_id": "GB123456789" - }, - "operator": { - "country": "UK", - "sex": "2" - }, - "about": { - "team_affiliation": [ - "ISPPA", - "Cardano Ambassador" - ], - "me": "Long description of me", - "server": "long description of server details", - "company": "long description of company details" - }, - "rss": "https://mycoolpool.com/xml/poolrss.xml" - } - ], - "properties": { - "CI": { + "title": "saturated recommendated", + "type": "object" + }, + "contact": { + "$id": "#/properties/pool/properties/contact", + "type": "object", + "title": "The contact schema", + "description": "An explanation about the purpose of this instance.", "default": {}, - "description": "All details related to corporate image", "examples": [ { - "logo_url_png_icon_64x64": "https://mycoolpool.com/icon.png", - "logo_url_png_logo": "https://mycoolpool.com/logo.png", - "color_main": "#RRGGBB", - "logo_vector": "https://mycoolpool.com/logo.svg" + "primary": "email", + "discord": "coolpool", + "email": "help@pooldomain.org", + "facebook": "coolpool", + "github": "coolpool", + "phone_call": "+44 123456789", + "phone_text": "+44 123456789", + "feed": "https://mycoolpool.com/xml/poolrss.xml", + "telegram": "coolpool", + "telegram_channel": "https://t.me/coolchannel", + "twitch": "coolpool", + "twitter": "coolpool", + "youtube": "coolpool" } ], - "title": "Corporate Image Details", + "required": [ + "primary", + "discord", + "email", + "facebook", + "github", + "phone_call", + "phone_text", + "feed", + "telegram", + "telegram_channel", + "twitch", + "twitter", + "youtube" + ], "properties": { - "logo_url_png_icon_64x64": { + "primary": { + "$id": "#/properties/pool/properties/contact/properties/primary", "default": "", - "description": "A small logo, 64x64 max size", + "description": "the pools prefered communication channel", "examples": [ - "https://mycoolpool.com/icon.png" + "email" ], - "pattern": "https?://(?:[a-z0-9\\-]+\\.)+[a-z]{2,6}(?:/[^/#?]+)+\\.png$", - "title": "The logo_url_png_icon_64x64" + "title": "primary contact preference", + "type": "string" }, - "logo_url_png_logo": { + "email": { + "$id": "#/properties/pool/properties/contact/properties/email", "default": "", - "description": "A pool logo", + "description": "valid email contact address", "examples": [ - "https://mycoolpool.com/logo.png" + "help@pooldomain.org" ], - "pattern": "https?://(?:[a-z0-9\\-]+\\.)+[a-z]{2,6}(?:/[^/#?]+)+\\.png$", - "title": "A url to a pool logo" + "title": "email address", + "type": "string" }, - "color_main": { + "facebook": { + "$id": "#/properties/pool/properties/contact/properties/facebook", "default": "", - "description": "HTML RGB color code with corporate background theme color", + "description": "a user or page name", "examples": [ - "#RRGGBB" + "coolpool" ], - "title": "Background color", - "pattern": "^[0-9a-fA-F]{6}$" + "title": "facebook account", + "type": "string" }, - "logo_vector": { + "github": { + "$id": "#/properties/pool/properties/contact/properties/github", "default": "", - "description": "svg defined vector logo", - "pattern": "https?://(?:[a-z0-9\\-]+\\.)+[a-z]{2,6}(?:/[^/#?]+)+\\.svg$", + "description": "a github username", "examples": [ - "https://mycoolpool.com/logo.svg" + "coolpool" + ], + "title": "github account", + "type": "string" + }, + "feed": { + "$id": "#/properties/pool/properties/contact/properties/feed", + "default": "", + "description": "RSS feed URL", + "examples": [ + "https://mycoolpool.com/xml/poolrss.xml" ], - "title": "vector logo" + "title": "RSS feed", + "type": "string" + }, + "telegram": { + "$id": "#/properties/pool/properties/contact/properties/telegram", + "default": "", + "description": "a telegram username", + "examples": [ + "coolpool" + ], + "title": "telegram account", + "type": "string" + }, + "twitter": { + "$id": "#/properties/pool/properties/contact/properties/twitter", + "default": "", + "description": "a twitter username", + "examples": [ + "coolpool" + ], + "title": "twitter account", + "type": "string" } }, "additionalProperties": true }, - "social": { - "$id": "#/properties/info/properties/social", + "technology": { + "$id": "#/properties/pool/properties/technology", "type": "object", - "title": "The social schema", + "title": "The technology schema", "description": "An explanation about the purpose of this instance.", "default": {}, "examples": [ { - "twitter_handle": "coolpool", - "telegram_handle": "coolpool", - "facebook_handle": "coolpool", - "youtube_handle": "coolpool", - "twitch_handle": "coolpool", - "discord_handle": "coolpool", - "github_handle": "coolpool" + "description": "We have a high availability setup with 2 block producers and 4 relays in 2 different data centers.", + "os": { + "$id": "#/properties/pools/items/anyOf/0/properties/os", + "type": "string", + "title": "Pool Operating System", + "description": "Pool Operating System", + "default": "", + "examples": [ + "Linux", + "macOS", + "Windows", + "BSD", + "Other", + "Undisclosed" + ] + }, + "infrastructure": { + "$id": "#/properties/pools/items/anyOf/0/properties/infrastructure", + "type": "string", + "title": "Pool Infrastructure", + "description": "Pool infrastructure Platform", + "default": "", + "examples": [ + "cloud", + "hosted bare metal", + "local bare metal", + "other", + "undisclosed" + ] + } } ], - + "required": [ + "description", + "os", + "infrastructure" + ], "properties": { - "twitter_handle": { + "description": { + "$id": "#/properties/pool/properties/technology/properties/description", + "type": "string", + "title": "The description schema", + "description": "An explanation about the purpose of this instance.", "default": "", - "description": "Twitter handle without leading @", "examples": [ - "coolpool" - ], - "title": "The twitter_handle schema", - "pattern": "^(\\w){1,15}$" + "We have a high availability setup with 2 block producers and 4 relays in 2 different data centers." + ] }, - "telegram_handle": { - "default": "", + "os": { + "$id": "#/properties/pool/properties/technology/properties/os", + "type": "object", + "title": "The os schema", "description": "An explanation about the purpose of this instance.", + "default": {}, "examples": [ - "coolpool" + { + "$id": "#/properties/pools/items/anyOf/0/properties/os", + "type": "string", + "title": "Pool Operating System", + "description": "Pool Operating System", + "default": "", + "examples": [ + "Linux", + "macOS", + "Windows", + "BSD", + "Other", + "Undisclosed" + ] + } + ], + "required": [ + "$id", + "type", + "title", + "description", + "default", + "examples" ], - "title": "The telegram_handle schema" - + "properties": { + "$id": { + "$id": "#/properties/pool/properties/technology/properties/os/properties/%24id", + "type": "string", + "title": "The $id schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "#/properties/pools/items/anyOf/0/properties/os" + ] + }, + "type": { + "$id": "#/properties/pool/properties/technology/properties/os/properties/type", + "type": "string", + "title": "The type schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "string" + ] + }, + "title": { + "$id": "#/properties/pool/properties/technology/properties/os/properties/title", + "type": "string", + "title": "The title schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "Pool Operating System" + ] + }, + "description": { + "$id": "#/properties/pool/properties/technology/properties/os/properties/description", + "type": "string", + "title": "The description schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "Pool Operating System" + ] + }, + "default": { + "$id": "#/properties/pool/properties/technology/properties/os/properties/default", + "type": "string", + "title": "The default schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "" + ] + }, + "examples": { + "$id": "#/properties/pool/properties/technology/properties/os/properties/examples", + "type": "array", + "title": "The examples schema", + "description": "An explanation about the purpose of this instance.", + "default": [], + "examples": [ + [ + "Linux", + "macOS" + ] + ], + "additionalItems": true, + "items": { + "$id": "#/properties/pool/properties/technology/properties/os/properties/examples/items", + "anyOf": [ + { + "$id": "#/properties/pool/properties/technology/properties/os/properties/examples/items/anyOf/0", + "type": "string", + "title": "The first anyOf schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "Linux", + "macOS" + ] + } + ] + } + } + }, + "additionalProperties": true }, - "facebook_handle": { - "default": "", + "infrastructure": { + "$id": "#/properties/pool/properties/technology/properties/infrastructure", + "type": "object", + "title": "The infrastructure schema", "description": "An explanation about the purpose of this instance.", + "default": {}, "examples": [ - "coolpool" + { + "$id": "#/properties/pools/items/anyOf/0/properties/infrastructure", + "type": "string", + "title": "Pool Infrastructure", + "description": "Pool infrastructure Platform", + "default": "", + "examples": [ + "cloud", + "hosted bare metal", + "local bare metal", + "other", + "undisclosed" + ] + } + ], + "required": [ + "$id", + "type", + "title", + "description", + "default", + "examples" ], - "title": "The facebook_handle schema", - "pattern": "^(\\w){1,55}$" + "properties": { + "$id": { + "$id": "#/properties/pool/properties/technology/properties/infrastructure/properties/%24id", + "type": "string", + "title": "The $id schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "#/properties/pools/items/anyOf/0/properties/infrastructure" + ] + }, + "type": { + "$id": "#/properties/pool/properties/technology/properties/infrastructure/properties/type", + "type": "string", + "title": "The type schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "string" + ] + }, + "title": { + "$id": "#/properties/pool/properties/technology/properties/infrastructure/properties/title", + "type": "string", + "title": "The title schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "Pool Infrastructure" + ] + }, + "description": { + "$id": "#/properties/pool/properties/technology/properties/infrastructure/properties/description", + "type": "string", + "title": "The description schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "Pool infrastructure Platform" + ] + }, + "default": { + "$id": "#/properties/pool/properties/technology/properties/infrastructure/properties/default", + "type": "string", + "title": "The default schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "" + ] + }, + "examples": { + "$id": "#/properties/pool/properties/technology/properties/infrastructure/properties/examples", + "type": "array", + "title": "The examples schema", + "description": "An explanation about the purpose of this instance.", + "default": [], + "examples": [ + [ + "cloud", + "hosted bare metal" + ] + ], + "additionalItems": true, + "items": { + "$id": "#/properties/pool/properties/technology/properties/infrastructure/properties/examples/items", + "anyOf": [ + { + "$id": "#/properties/pool/properties/technology/properties/infrastructure/properties/examples/items/anyOf/0", + "type": "string", + "title": "The first anyOf schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "cloud", + "hosted bare metal" + ] + } + ] + } + } + }, + "additionalProperties": true + } + }, + "additionalProperties": true + }, + "media_assets": { + "$id": "#/properties/pool/properties/media_assets", + "type": "object", + "title": "The media_assets schema", + "description": "An explanation about the purpose of this instance.", + "default": {}, + "examples": [ + { + "icon_png_64x64": "https://mycoolpool.com/icon.png", + "logo_png": "https://mycoolpool.com/logo.png", + "logo_svg": "https://mycoolpool.com/logo.svg", + "color_fg": "#RRGGBB", + "color_bg": "#RRGGBB" + } + ], + "required": [ + "icon_png_64x64", + "logo_png", + "logo_svg", + "color_fg", + "color_bg" + ], + "properties": { + "icon_png_64x64": { + "$id": "#/properties/pool/properties/media_assets/properties/icon_png_64x64", + "type": "string", + "title": "The icon_png_64x64 schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "https://mycoolpool.com/icon.png" + ] }, - "youtube_handle": { - "$id": "#/properties/info/properties/social/properties/youtube_handle", + "logo_png": { + "$id": "#/properties/pool/properties/media_assets/properties/logo_png", "type": "string", - "title": "The youtube_handle schema", + "title": "The logo_png schema", "description": "An explanation about the purpose of this instance.", "default": "", "examples": [ - "coolpool" + "https://mycoolpool.com/logo.png" ] }, - "twitch_handle": { - "$id": "#/properties/info/properties/social/properties/twitch_handle", + "logo_svg": { + "$id": "#/properties/pool/properties/media_assets/properties/logo_svg", "type": "string", - "title": "The twitch_handle schema", + "title": "The logo_svg schema", "description": "An explanation about the purpose of this instance.", "default": "", "examples": [ - "coolpool" + "https://mycoolpool.com/logo.svg" ] }, - "discord_handle": { - "$id": "#/properties/info/properties/social/properties/discord_handle", + "color_fg": { + "$id": "#/properties/pool/properties/media_assets/properties/color_fg", "type": "string", - "title": "The discord_handle schema", + "title": "The color_fg schema", "description": "An explanation about the purpose of this instance.", "default": "", "examples": [ - "coolpool" + "#RRGGBB" ] }, - "github_handle": { - "$id": "#/properties/info/properties/social/properties/github_handle", + "color_bg": { + "$id": "#/properties/pool/properties/media_assets/properties/color_bg", "type": "string", - "title": "The github_handle schema", + "title": "The color_bg schema", "description": "An explanation about the purpose of this instance.", "default": "", "examples": [ - "coolpool" + "#RRGGBB" ] } }, "additionalProperties": true }, - "contact": { - "$id": "#/properties/info/properties/contact", + "affiliations": { + "$id": "#/properties/pool/properties/affiliations", + "type": "array", + "title": "The affiliations schema", + "description": "An explanation about the purpose of this instance.", + "default": [], + "examples": [ + [ + "ISPPA", + "Cardano Ambassador" + ] + ], + "additionalItems": true, + "items": { + "$id": "#/properties/pool/properties/affiliations/items", + "anyOf": [ + { + "$id": "#/properties/pool/properties/affiliations/items/anyOf/0", + "type": "string", + "title": "The first anyOf schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "ISPPA", + "Cardano Ambassador" + ] + } + ] + } + }, + "supporting": { + "$id": "#/properties/pool/properties/supporting", + "type": "array", + "title": "The supporting schema", + "description": "An explanation about the purpose of this instance.", + "default": [], + "examples": [ + [ + "10% of fees donated to Save the Frogs.", + "Some proceeds used to sponsor local Cardano meetup." + ] + ], + "additionalItems": true, + "items": { + "$id": "#/properties/pool/properties/supporting/items", + "anyOf": [ + { + "$id": "#/properties/pool/properties/supporting/items/anyOf/0", + "type": "string", + "title": "The first anyOf schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "10% of fees donated to Save the Frogs.", + "Some proceeds used to sponsor local Cardano meetup." + ] + } + ] + } + }, + "itn": { + "$id": "#/properties/pool/properties/itn", "type": "object", - "title": "The contact schema", + "title": "The itn schema", "description": "An explanation about the purpose of this instance.", "default": {}, "examples": [ { - "abuse": "abuse@pooldomain.org", - "support": "help@pooldomain.org", - "telegram_admin":"coolpool" + "owner": "ed25519_pk1...", + "witness": "ed25519_sig1..." } ], - + "required": [ + "owner", + "witness" + ], "properties": { - "abuse": { - "default": "", - "description": "Abuse contact email", - "examples": [ - "abuse@pooldomain.org" - ], - "title": "Abuse Contact email" - }, - "support": { + "owner": { + "$id": "#/properties/pool/properties/itn/properties/owner", + "type": "string", + "title": "The owner schema", + "description": "An explanation about the purpose of this instance.", "default": "", - "description": "Support contact email", "examples": [ - "help@pooldomain.org" - ], - "title": "Support Contact Email" + "ed25519_pk1..." + ] }, - "telegram_admin": { + "witness": { + "$id": "#/properties/pool/properties/itn/properties/witness", + "type": "string", + "title": "The witness schema", + "description": "An explanation about the purpose of this instance.", "default": "", - "description": "The administrator telegram contact handle", "examples": [ - "coolpool" - ], - "title": "he administrator telegram contact handle" - + "ed25519_sig1..." + ] } }, "additionalProperties": true + } + }, + "additionalProperties": true + }, + "operator": { + "$id": "#/properties/operator", + "type": "object", + "title": "The operator schema", + "description": "An explanation about the purpose of this instance.", + "default": {}, + "examples": [ + { + "description": "Cool Ops operates pools for people.", + "person": { + "name": "Juanita Lopez", + "address": "101 Main St., Suite 3", + "city": "London", + "state_or_region": "", + "postal_code": "123456", + "country": "UK", + "gender": "2" + }, + "organization": { + "name": "Cool Ops LLC", + "government_id": "123456789", + "vat_id": "GB123456789", + "address": "101 Main St.", + "city": "London", + "state_or_region": "", + "postal_code": "123456", + "country": "UK" + } + } + ], + "required": [ + "description", + "person", + "organization" + ], + "properties": { + "description": { + "$id": "#/properties/operator/properties/description", + "type": "string", + "title": "The description schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "Cool Ops operates pools for people." + ] }, - "company": { - "$id": "#/properties/info/properties/company", + "person": { + "$id": "#/properties/operator/properties/person", "type": "object", - "title": "Company Details", - "description": "Contact details of company", + "title": "The person schema", + "description": "An explanation about the purpose of this instance.", "default": {}, "examples": [ { - "name": "Company Name", - "addr": "Street, Number", + "name": "Juanita Lopez", + "address": "101 Main St., Suite 3", "city": "London", + "state_or_region": "", + "postal_code": "123456", "country": "UK", - "company_id": "123456789", - "vat_id": "GB123456789" + "gender": "2" } ], + "required": [ + "name", + "address", + "city", + "state_or_region", + "postal_code", + "country", + "gender" + ], "properties": { "name": { - "$id": "#/properties/info/properties/company/properties/name", + "$id": "#/properties/operator/properties/person/properties/name", "type": "string", - "title": "Company Name", - "description": "Company Name.", + "title": "The name schema", + "description": "An explanation about the purpose of this instance.", "default": "", "examples": [ - "Company Name" + "Juanita Lopez" ] }, - "addr": { - "$id": "#/properties/info/properties/company/properties/addr", + "address": { + "$id": "#/properties/operator/properties/person/properties/address", "type": "string", - "title": "Company ddress", - "description": "Company ddress", + "title": "The address schema", + "description": "An explanation about the purpose of this instance.", "default": "", "examples": [ - "5534 HappyPool Lane" + "101 Main St., Suite 3" ] }, "city": { - "$id": "#/properties/info/properties/company/properties/city", + "$id": "#/properties/operator/properties/person/properties/city", "type": "string", - "title": "Company City", - "description": "Company City", + "title": "The city schema", + "description": "An explanation about the purpose of this instance.", "default": "", "examples": [ "London" ] }, - "country": { - "$id": "#/properties/info/properties/company/properties/country", + "state_or_region": { + "$id": "#/properties/operator/properties/person/properties/state_or_region", "type": "string", - "title": "Company Country", - "description": "ISO 3166-2 2-letter country code", + "title": "The state_or_region schema", + "description": "An explanation about the purpose of this instance.", "default": "", "examples": [ - "UK" + "" ] }, - "company_id": { - "$id": "#/properties/info/properties/company/properties/company_id", + "postal_code": { + "$id": "#/properties/operator/properties/person/properties/postal_code", "type": "string", - "title": "company id", - "description": "company id", + "title": "The postal_code schema", + "description": "An explanation about the purpose of this instance.", "default": "", "examples": [ - "123456789" + "123456" ] }, - "vat_id": { - "$id": "#/properties/info/properties/company/properties/vat_id", + "country": { + "$id": "#/properties/operator/properties/person/properties/country", "type": "string", - "title": "company vat id", - "description": "company vat id", + "title": "The country schema", + "description": "An explanation about the purpose of this instance.", "default": "", "examples": [ - "GB123456789" + "UK" + ] + }, + "gender": { + "$id": "#/properties/operator/properties/person/properties/gender", + "type": "string", + "title": "The gender schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "2" ] } }, "additionalProperties": true }, - "operator": { - "$id": "#/properties/info/properties/operator", + "organization": { + "$id": "#/properties/operator/properties/organization", "type": "object", - "title": "The operator schema", + "title": "The organization schema", "description": "An explanation about the purpose of this instance.", "default": {}, "examples": [ { - "country": "UK", - "sex": "0" + "name": "Cool Ops LLC", + "government_id": "123456789", + "vat_id": "GB123456789", + "address": "101 Main St.", + "city": "London", + "state_or_region": "", + "postal_code": "123456", + "country": "UK" } ], - + "required": [ + "name", + "government_id", + "vat_id", + "address", + "city", + "state_or_region", + "postal_code", + "country" + ], "properties": { - "country": { - "$id": "#/properties/info/properties/operator/properties/country", + "name": { + "$id": "#/properties/operator/properties/organization/properties/name", "type": "string", - "title": "The country schema", - "description": "ISO 3166-2 2-letter country code", + "title": "The name schema", + "description": "An explanation about the purpose of this instance.", "default": "", "examples": [ - "UK" + "Cool Ops LLC" ] }, - "sex": { - "$id": "#/properties/info/properties/operator/properties/sex", + "government_id": { + "$id": "#/properties/operator/properties/organization/properties/government_id", "type": "string", - "title": "The sex schema", - "description": "ISO/IEC 5218 sex", + "title": "The government_id schema", + "description": "An explanation about the purpose of this instance.", "default": "", "examples": [ - "1" + "123456789" ] - } - }, - "additionalProperties": true - }, - "about": { - "$id": "#/properties/info/properties/about", - "type": "object", - "title": "The about schema", - "description": "An explanation about the purpose of this instance.", - "default": {}, - "examples": [ - { - "team_affiliation": [ - "ISPPA", - "Cardano Ambassador" - ], - "me": "Long description of me", - "server": "long description of server details", - "company": "long description of company details" - } - ], - "properties": { - "team_affiliation": { - "$id": "#/properties/info/properties/about/properties/team_affiliation", - "type": "array", - "title": "Team Affiliations", - "description": "Case insensitive affiliations. Matching performed on entire string.", - "default": [], - "examples": [ - [ - "ISPPA", - "Cardano Ambassador" - ] - ], - "additionalItems": true, - "items": { - "$id": "#/properties/info/properties/about/properties/team_affiliation/items", - "anyOf": [ - { - "$id": "#/properties/info/properties/about/properties/team_affiliation/items/anyOf/0", - "type": "string", - "title": "Team Name", - "description": "Case insensitive affiliations. Matching performed on entire string.", - "default": "", - "examples": [ - "ISPPA", - "Cardano Ambassador" - ] - } - ] - } }, - "me": { - "$id": "#/properties/info/properties/about/properties/me", + "vat_id": { + "$id": "#/properties/operator/properties/organization/properties/vat_id", "type": "string", - "title": "Long Description Me", - "description": "Long Description. valid HTML tags are


", + "title": "The vat_id schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "GB123456789" + ] + }, + "address": { + "$id": "#/properties/operator/properties/organization/properties/address", + "type": "string", + "title": "The address schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "101 Main St." + ] + }, + "city": { + "$id": "#/properties/operator/properties/organization/properties/city", + "type": "string", + "title": "The city schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "London" + ] + }, + "state_or_region": { + "$id": "#/properties/operator/properties/organization/properties/state_or_region", + "type": "string", + "title": "The state_or_region schema", + "description": "An explanation about the purpose of this instance.", "default": "", "examples": [ - "Long description of me" + "" ] }, - "server": { - "$id": "#/properties/info/properties/about/properties/server", + "postal_code": { + "$id": "#/properties/operator/properties/organization/properties/postal_code", "type": "string", - "title": "Long Description Server", - "description": "Long Description. valid HTML tags are


", + "title": "The postal_code schema", + "description": "An explanation about the purpose of this instance.", "default": "", "examples": [ - "long description of server details" + "123456" ] }, - "company": { - "$id": "#/properties/info/properties/about/properties/company", + "country": { + "$id": "#/properties/operator/properties/organization/properties/country", "type": "string", - "title": "Long Description Company", - "description": "Long Description. valid HTML tags are


", + "title": "The country schema", + "description": "An explanation about the purpose of this instance.", "default": "", "examples": [ - "long description of company details" + "UK" ] } }, "additionalProperties": true - }, - "rss": { - "$id": "#/properties/info/properties/rss", - "type": "string", - "title": "Rss Feed", - "description": "URL to an RSS feed", - "default": "", - "examples": [ - "https://mycoolpool.com/xml/poolrss.xml" - ] } }, "additionalProperties": true }, - "pool": { - "$id": "#/properties/pools", + "owner": { + "$id": "#/properties/owner", "type": "object", - "title": "Pool Details", - "description": "All pool details.", + "title": "The owner schema", + "description": "An explanation about the purpose of this instance.", "default": {}, "examples": [ { - "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", - "country": "UK", - "os": "LINUX", - "infrastructure": "AWS", - "status": "act", - "saturated_recommend": "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" + "description": "I am a podcaster and believer in Cardano.", + "person": { + "name": "Ramesh Patel", + "address": "", + "city": "Vancouver", + "state_or_region": "BC", + "postal_code": "", + "country": "CA", + "gender": "1" + } } - ], "required": [ - "id" + "description", + "person" ], - "properties": { - "id": { - "$id": "#/properties/pools/items/anyOf/0/properties/id", + "description": { + "$id": "#/properties/owner/properties/description", "type": "string", - "title": "The poolid", - "description": "Valid Mainnet Pool Id (hex format)", - "default": "", - "examples": [ - "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" - ] - }, - "country": { - "$id": "#/properties/pools/items/anyOf/0/properties/country", - "type": "string", - "title": "Pool country", - "description": "ISO 3166-2 2-letter country code", - "default": "", - "examples": [ - "UK" - ] - }, - "os": { - "$id": "#/properties/pools/items/anyOf/0/properties/os", - "type": "string", - "title": "Pool Operating System", - "description": "Pool Operating System", - "default": "", - "examples": [ - "LINUX", - "OSX", - "WIN", - "FREEBSD", - "UNDISCLOSED" - ] - }, - "infrastructure": { - "$id": "#/properties/pools/items/anyOf/0/properties/infrastructure", - "type": "string", - "title": "Pool Infrastructure", - "description": "Pool infrastructure Platform", - "default": "", - "examples": [ - "AWS", - "GOOGLE", - "AZURE", - "DIGITALOCEAN", - "BAREMETALL", - "BAREMETALH", - "OVH", - "HETZNER", - "VULTR", - "GODADDY", - "ARUBA", - "HOSTINGER", - "OTHERVPS", - "LPCSBC", - "UNDISCLOSED" - ] - }, - "status": { - "$id": "#/properties/pools/items/anyOf/0/properties/status", - "type": "string", - "title": "Pool Status", - "description": "Pool Current Status", + "title": "The description schema", + "description": "An explanation about the purpose of this instance.", "default": "", "examples": [ - "ACT","RET","OFF","EXP","DNU" + "I am a podcaster and believer in Cardano." ] }, - "saturated_recommend": { - "$id": "#/properties/pools/items/anyOf/0/properties/saturated_recommend", - "type": "string", - "title": "Saturated Recommend", - "description": "If the pool is saturated recommend this pool", - "default": "", + "person": { + "$id": "#/properties/owner/properties/person", + "type": "object", + "title": "The person schema", + "description": "An explanation about the purpose of this instance.", + "default": {}, "examples": [ - "0a0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f" - ] + { + "name": "Ramesh Patel", + "address": "", + "city": "Vancouver", + "state_or_region": "BC", + "postal_code": "", + "country": "CA", + "gender": "1" + } + ], + "required": [ + "name", + "address", + "city", + "state_or_region", + "postal_code", + "country", + "gender" + ], + "properties": { + "name": { + "$id": "#/properties/owner/properties/person/properties/name", + "type": "string", + "title": "The name schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "Ramesh Patel" + ] + }, + "address": { + "$id": "#/properties/owner/properties/person/properties/address", + "type": "string", + "title": "The address schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "" + ] + }, + "city": { + "$id": "#/properties/owner/properties/person/properties/city", + "type": "string", + "title": "The city schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "Vancouver" + ] + }, + "state_or_region": { + "$id": "#/properties/owner/properties/person/properties/state_or_region", + "type": "string", + "title": "The state_or_region schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "BC" + ] + }, + "postal_code": { + "$id": "#/properties/owner/properties/person/properties/postal_code", + "type": "string", + "title": "The postal_code schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "" + ] + }, + "country": { + "$id": "#/properties/owner/properties/person/properties/country", + "type": "string", + "title": "The country schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "CA" + ] + }, + "gender": { + "$id": "#/properties/owner/properties/person/properties/gender", + "type": "string", + "title": "The gender schema", + "description": "An explanation about the purpose of this instance.", + "default": "", + "examples": [ + "1" + ] + } + }, + "additionalProperties": true } }, "additionalProperties": true From d8eca34ebd06977ebe6a839810854ac5757dfe84 Mon Sep 17 00:00:00 2001 From: Markus Date: Tue, 1 Dec 2020 10:02:12 +0100 Subject: [PATCH 07/11] Rename CIP6.md to CIP-0006.md --- CIP6/{CIP6.md => CIP-0006.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename CIP6/{CIP6.md => CIP-0006.md} (100%) diff --git a/CIP6/CIP6.md b/CIP6/CIP-0006.md similarity index 100% rename from CIP6/CIP6.md rename to CIP6/CIP-0006.md From a31f2ef12b104053a7b90d1789a07e3087f2caa1 Mon Sep 17 00:00:00 2001 From: Markus Date: Tue, 1 Dec 2020 10:03:22 +0100 Subject: [PATCH 08/11] Rename CIP6/CIP-0006.md to CIP-0006/CIP-0006.md --- {CIP6 => CIP-0006}/CIP-0006.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename {CIP6 => CIP-0006}/CIP-0006.md (100%) diff --git a/CIP6/CIP-0006.md b/CIP-0006/CIP-0006.md similarity index 100% rename from CIP6/CIP-0006.md rename to CIP-0006/CIP-0006.md From 61d1efeba4e7e4cd03e607a6be0c885dbc5f383d Mon Sep 17 00:00:00 2001 From: Markus Date: Tue, 1 Dec 2020 10:03:49 +0100 Subject: [PATCH 09/11] Rename CIP6/schema.json to CIP-0006/schema.json --- {CIP6 => CIP-0006}/schema.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename {CIP6 => CIP-0006}/schema.json (99%) diff --git a/CIP6/schema.json b/CIP-0006/schema.json similarity index 99% rename from CIP6/schema.json rename to CIP-0006/schema.json index 1d2bb014b..c88963853 100644 --- a/CIP6/schema.json +++ b/CIP-0006/schema.json @@ -1239,4 +1239,4 @@ } }, "additionalProperties": true -} \ No newline at end of file +} From 3a1a7ad9c3790e9a3f6d7528f4b799c5150af24d Mon Sep 17 00:00:00 2001 From: Markus Date: Tue, 1 Dec 2020 10:10:51 +0100 Subject: [PATCH 10/11] Delete LICENSE --- CIP6/LICENSE | 395 --------------------------------------------------- 1 file changed, 395 deletions(-) delete mode 100644 CIP6/LICENSE diff --git a/CIP6/LICENSE b/CIP6/LICENSE deleted file mode 100644 index f987f3daa..000000000 --- a/CIP6/LICENSE +++ /dev/null @@ -1,395 +0,0 @@ -Attribution 4.0 International - -======================================================================= - -Creative Commons Corporation ("Creative Commons") is not a law firm and -does not provide legal services or legal advice. Distribution of -Creative Commons public licenses does not create a lawyer-client or -other relationship. Creative Commons makes its licenses and related -information available on an "as-is" basis. Creative Commons gives no -warranties regarding its licenses, any material licensed under their -terms and conditions, or any related information. Creative Commons -disclaims all liability for damages resulting from their use to the -fullest extent possible. - -Using Creative Commons Public Licenses - -Creative Commons public licenses provide a standard set of terms and -conditions that creators and other rights holders may use to share -original works of authorship and other material subject to copyright -and certain other rights specified in the public license below. The -following considerations are for informational purposes only, are not -exhaustive, and do not form part of our licenses. - - Considerations for licensors: Our public licenses are - intended for use by those authorized to give the public - permission to use material in ways otherwise restricted by - copyright and certain other rights. Our licenses are - irrevocable. Licensors should read and understand the terms - and conditions of the license they choose before applying it. - Licensors should also secure all rights necessary before - applying our licenses so that the public can reuse the - material as expected. Licensors should clearly mark any - material not subject to the license. This includes other CC- - licensed material, or material used under an exception or - limitation to copyright. More considerations for licensors: - wiki.creativecommons.org/Considerations_for_licensors - - Considerations for the public: By using one of our public - licenses, a licensor grants the public permission to use the - licensed material under specified terms and conditions. If - the licensor's permission is not necessary for any reason--for - example, because of any applicable exception or limitation to - copyright--then that use is not regulated by the license. Our - licenses grant only permissions under copyright and certain - other rights that a licensor has authority to grant. Use of - the licensed material may still be restricted for other - reasons, including because others have copyright or other - rights in the material. A licensor may make special requests, - such as asking that all changes be marked or described. - Although not required by our licenses, you are encouraged to - respect those requests where reasonable. More considerations - for the public: - wiki.creativecommons.org/Considerations_for_licensees - -======================================================================= - -Creative Commons Attribution 4.0 International Public License - -By exercising the Licensed Rights (defined below), You accept and agree -to be bound by the terms and conditions of this Creative Commons -Attribution 4.0 International Public License ("Public License"). To the -extent this Public License may be interpreted as a contract, You are -granted the Licensed Rights in consideration of Your acceptance of -these terms and conditions, and the Licensor grants You such rights in -consideration of benefits the Licensor receives from making the -Licensed Material available under these terms and conditions. - - -Section 1 -- Definitions. - - a. Adapted Material means material subject to Copyright and Similar - Rights that is derived from or based upon the Licensed Material - and in which the Licensed Material is translated, altered, - arranged, transformed, or otherwise modified in a manner requiring - permission under the Copyright and Similar Rights held by the - Licensor. For purposes of this Public License, where the Licensed - Material is a musical work, performance, or sound recording, - Adapted Material is always produced where the Licensed Material is - synched in timed relation with a moving image. - - b. Adapter's License means the license You apply to Your Copyright - and Similar Rights in Your contributions to Adapted Material in - accordance with the terms and conditions of this Public License. - - c. Copyright and Similar Rights means copyright and/or similar rights - closely related to copyright including, without limitation, - performance, broadcast, sound recording, and Sui Generis Database - Rights, without regard to how the rights are labeled or - categorized. For purposes of this Public License, the rights - specified in Section 2(b)(1)-(2) are not Copyright and Similar - Rights. - - d. Effective Technological Measures means those measures that, in the - absence of proper authority, may not be circumvented under laws - fulfilling obligations under Article 11 of the WIPO Copyright - Treaty adopted on December 20, 1996, and/or similar international - agreements. - - e. Exceptions and Limitations means fair use, fair dealing, and/or - any other exception or limitation to Copyright and Similar Rights - that applies to Your use of the Licensed Material. - - f. Licensed Material means the artistic or literary work, database, - or other material to which the Licensor applied this Public - License. - - g. Licensed Rights means the rights granted to You subject to the - terms and conditions of this Public License, which are limited to - all Copyright and Similar Rights that apply to Your use of the - Licensed Material and that the Licensor has authority to license. - - h. Licensor means the individual(s) or entity(ies) granting rights - under this Public License. - - i. Share means to provide material to the public by any means or - process that requires permission under the Licensed Rights, such - as reproduction, public display, public performance, distribution, - dissemination, communication, or importation, and to make material - available to the public including in ways that members of the - public may access the material from a place and at a time - individually chosen by them. - - j. Sui Generis Database Rights means rights other than copyright - resulting from Directive 96/9/EC of the European Parliament and of - the Council of 11 March 1996 on the legal protection of databases, - as amended and/or succeeded, as well as other essentially - equivalent rights anywhere in the world. - - k. You means the individual or entity exercising the Licensed Rights - under this Public License. Your has a corresponding meaning. - - -Section 2 -- Scope. - - a. License grant. - - 1. Subject to the terms and conditions of this Public License, - the Licensor hereby grants You a worldwide, royalty-free, - non-sublicensable, non-exclusive, irrevocable license to - exercise the Licensed Rights in the Licensed Material to: - - a. reproduce and Share the Licensed Material, in whole or - in part; and - - b. produce, reproduce, and Share Adapted Material. - - 2. Exceptions and Limitations. For the avoidance of doubt, where - Exceptions and Limitations apply to Your use, this Public - License does not apply, and You do not need to comply with - its terms and conditions. - - 3. Term. The term of this Public License is specified in Section - 6(a). - - 4. Media and formats; technical modifications allowed. The - Licensor authorizes You to exercise the Licensed Rights in - all media and formats whether now known or hereafter created, - and to make technical modifications necessary to do so. The - Licensor waives and/or agrees not to assert any right or - authority to forbid You from making technical modifications - necessary to exercise the Licensed Rights, including - technical modifications necessary to circumvent Effective - Technological Measures. For purposes of this Public License, - simply making modifications authorized by this Section 2(a) - (4) never produces Adapted Material. - - 5. Downstream recipients. - - a. Offer from the Licensor -- Licensed Material. Every - recipient of the Licensed Material automatically - receives an offer from the Licensor to exercise the - Licensed Rights under the terms and conditions of this - Public License. - - b. No downstream restrictions. You may not offer or impose - any additional or different terms or conditions on, or - apply any Effective Technological Measures to, the - Licensed Material if doing so restricts exercise of the - Licensed Rights by any recipient of the Licensed - Material. - - 6. No endorsement. Nothing in this Public License constitutes or - may be construed as permission to assert or imply that You - are, or that Your use of the Licensed Material is, connected - with, or sponsored, endorsed, or granted official status by, - the Licensor or others designated to receive attribution as - provided in Section 3(a)(1)(A)(i). - - b. Other rights. - - 1. Moral rights, such as the right of integrity, are not - licensed under this Public License, nor are publicity, - privacy, and/or other similar personality rights; however, to - the extent possible, the Licensor waives and/or agrees not to - assert any such rights held by the Licensor to the limited - extent necessary to allow You to exercise the Licensed - Rights, but not otherwise. - - 2. Patent and trademark rights are not licensed under this - Public License. - - 3. To the extent possible, the Licensor waives any right to - collect royalties from You for the exercise of the Licensed - Rights, whether directly or through a collecting society - under any voluntary or waivable statutory or compulsory - licensing scheme. In all other cases the Licensor expressly - reserves any right to collect such royalties. - - -Section 3 -- License Conditions. - -Your exercise of the Licensed Rights is expressly made subject to the -following conditions. - - a. Attribution. - - 1. If You Share the Licensed Material (including in modified - form), You must: - - a. retain the following if it is supplied by the Licensor - with the Licensed Material: - - i. identification of the creator(s) of the Licensed - Material and any others designated to receive - attribution, in any reasonable manner requested by - the Licensor (including by pseudonym if - designated); - - ii. a copyright notice; - - iii. a notice that refers to this Public License; - - iv. a notice that refers to the disclaimer of - warranties; - - v. a URI or hyperlink to the Licensed Material to the - extent reasonably practicable; - - b. indicate if You modified the Licensed Material and - retain an indication of any previous modifications; and - - c. indicate the Licensed Material is licensed under this - Public License, and include the text of, or the URI or - hyperlink to, this Public License. - - 2. You may satisfy the conditions in Section 3(a)(1) in any - reasonable manner based on the medium, means, and context in - which You Share the Licensed Material. For example, it may be - reasonable to satisfy the conditions by providing a URI or - hyperlink to a resource that includes the required - information. - - 3. If requested by the Licensor, You must remove any of the - information required by Section 3(a)(1)(A) to the extent - reasonably practicable. - - 4. If You Share Adapted Material You produce, the Adapter's - License You apply must not prevent recipients of the Adapted - Material from complying with this Public License. - - -Section 4 -- Sui Generis Database Rights. - -Where the Licensed Rights include Sui Generis Database Rights that -apply to Your use of the Licensed Material: - - a. for the avoidance of doubt, Section 2(a)(1) grants You the right - to extract, reuse, reproduce, and Share all or a substantial - portion of the contents of the database; - - b. if You include all or a substantial portion of the database - contents in a database in which You have Sui Generis Database - Rights, then the database in which You have Sui Generis Database - Rights (but not its individual contents) is Adapted Material; and - - c. You must comply with the conditions in Section 3(a) if You Share - all or a substantial portion of the contents of the database. - -For the avoidance of doubt, this Section 4 supplements and does not -replace Your obligations under this Public License where the Licensed -Rights include other Copyright and Similar Rights. - - -Section 5 -- Disclaimer of Warranties and Limitation of Liability. - - a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE - EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS - AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF - ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, - IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, - WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR - PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, - ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT - KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT - ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. - - b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE - TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, - NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, - INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, - COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR - USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN - ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR - DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR - IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. - - c. The disclaimer of warranties and limitation of liability provided - above shall be interpreted in a manner that, to the extent - possible, most closely approximates an absolute disclaimer and - waiver of all liability. - - -Section 6 -- Term and Termination. - - a. This Public License applies for the term of the Copyright and - Similar Rights licensed here. However, if You fail to comply with - this Public License, then Your rights under this Public License - terminate automatically. - - b. Where Your right to use the Licensed Material has terminated under - Section 6(a), it reinstates: - - 1. automatically as of the date the violation is cured, provided - it is cured within 30 days of Your discovery of the - violation; or - - 2. upon express reinstatement by the Licensor. - - For the avoidance of doubt, this Section 6(b) does not affect any - right the Licensor may have to seek remedies for Your violations - of this Public License. - - c. For the avoidance of doubt, the Licensor may also offer the - Licensed Material under separate terms or conditions or stop - distributing the Licensed Material at any time; however, doing so - will not terminate this Public License. - - d. Sections 1, 5, 6, 7, and 8 survive termination of this Public - License. - - -Section 7 -- Other Terms and Conditions. - - a. The Licensor shall not be bound by any additional or different - terms or conditions communicated by You unless expressly agreed. - - b. Any arrangements, understandings, or agreements regarding the - Licensed Material not stated herein are separate from and - independent of the terms and conditions of this Public License. - - -Section 8 -- Interpretation. - - a. For the avoidance of doubt, this Public License does not, and - shall not be interpreted to, reduce, limit, restrict, or impose - conditions on any use of the Licensed Material that could lawfully - be made without permission under this Public License. - - b. To the extent possible, if any provision of this Public License is - deemed unenforceable, it shall be automatically reformed to the - minimum extent necessary to make it enforceable. If the provision - cannot be reformed, it shall be severed from this Public License - without affecting the enforceability of the remaining terms and - conditions. - - c. No term or condition of this Public License will be waived and no - failure to comply consented to unless expressly agreed to by the - Licensor. - - d. Nothing in this Public License constitutes or may be interpreted - as a limitation upon, or waiver of, any privileges and immunities - that apply to the Licensor or You, including from the legal - processes of any jurisdiction or authority. - - -======================================================================= - -Creative Commons is not a party to its public licenses. -Notwithstanding, Creative Commons may elect to apply one of its public -licenses to material it publishes and in those instances will be -considered the “Licensor.” The text of the Creative Commons public -licenses is dedicated to the public domain under the CC0 Public Domain -Dedication. Except for the limited purpose of indicating that material -is shared under a Creative Commons public license or as otherwise -permitted by the Creative Commons policies published at -creativecommons.org/policies, Creative Commons does not authorize the -use of the trademark "Creative Commons" or any other trademark or logo -of Creative Commons without its prior written consent including, -without limitation, in connection with any unauthorized modifications -to any of its public licenses or any other arrangements, -understandings, or agreements concerning use of licensed material. For -the avoidance of doubt, this paragraph does not form part of the public -licenses. - -Creative Commons may be contacted at creativecommons.org. \ No newline at end of file From 4006d061dd3ffdacb77002e3255b745bed17464d Mon Sep 17 00:00:00 2001 From: Markus Date: Tue, 9 Feb 2021 00:21:34 +0100 Subject: [PATCH 11/11] add explanation and json schema --- CIP-0006/CIP-0006.md | 350 ++++++++++++++++++++++++++++++++++++------- 1 file changed, 292 insertions(+), 58 deletions(-) diff --git a/CIP-0006/CIP-0006.md b/CIP-0006/CIP-0006.md index 1ae9f00a7..9ed0f63bd 100644 --- a/CIP-0006/CIP-0006.md +++ b/CIP-0006/CIP-0006.md @@ -1,12 +1,13 @@ --- -CIP: 6 -Title: Extended Metadata +CIP: 0006 +Title: Stake Pool Extended Metadata Authors: Markus Gufler , Mike Fullman Comments-URI: Status: Draft Type: Standards Created: 2020-07-20 original draft Updated: 2020-11-24 2nd key-pair for validation +Updated: 2021-02-08 json schema License: CC-BY-4.0 --- @@ -39,7 +40,7 @@ We define two more fields for the on chain referenced metadata file that referen | `homepage` | A website URL for the pool| 64 Characters Maximum, must be a valid URL | | `name` | A name for the pool | 50 Characters Maximum | | `extDataUrl` | A URL for extended metadata | optional, 128 Characters Maximum, must be a valid URL | -| `extHashUrl` | A URL with the extended metadata hash | optional, 128 Characters Maximum, must be a valid URL | +| `extSigUrl` | A URL with the extended metadata signature | optional, 128 Characters Maximum, must be a valid URL | | `extVkey` | the public Key for verification | optional, 68 Characters | In order to include the additional ext Field data, we suggest increasing the maximum size of the main metadata file from currently 512 to 1024 bytes. @@ -53,16 +54,16 @@ The operator notes all his additional pool information in the extended metadata We propose the pool operator generate a new public-secret key-pair (`extData.skey` and `extData.vkey`) ```shell -cardano-cli shelley node key-gen +cardano-cli node key-gen --cold-verification-key-file extData.vkey --cold-signing-key-file extData.skey --operational-certificate-issue-counter-file extData.counter ``` -Then a new (not available yet) `cardano-cli` command generate the signed hash (`extData.sign`) . +Then a new (not available yet) `cardano-cli` command generate the signature (`extData.sign`) . ```shell -cardano-cli shelley stake-pool rawdata-hash +cardano-cli stake-pool rawdata-sign --raw-metadata-file extData.json --signing-key-file extData.skey --out-file extData.sign @@ -72,78 +73,311 @@ The operator now: - has the `extData.json` and `extData.sign` files - will publish them at some https:// URL (probably same host as the main metadata) -- use the `extData.vkey` string and the two extend file URLs to re-register the main metadata +- set the published `extData.json` URL in the main metadata `extDataUrl` field +- set the published `extData.sign` URL in then main metadata `extSigUrl` field +- set the `extData.vkey` string in the main metadata `extVkey` field +- re-register the extended main metadata file on chain -This re-registration of the main metadata file with the `extData.vkey` and the two URLs is only necessary once. Afterwards, the operator can update his extended metadata at any time, generate the new signature and put both files online. +This re-registration of the main metadata file with the `extData.vkey` and the two URLs is only necessary once. Afterwards, the operator can update his extended metadata at any time, compute the new signature with the `cardano-cli stake-pool rawdata-sign` command, and publish both files at the existing `extDataUrl` and `extSigUrl`. ### Extended Metadata structure In the following we describe a first minimal version of the extended Json file format -Since this extended metadata file can be updated at any time by the pool operator, a **serial number** is useful to easily identify updates. +Since this extended metadata file can be updated at any time by the pool operator, a **serial number** is useful for consuming applications and services to identify updates. There are main thematic sections with respective subordinate data fields: - the **itn** section is about the verifiable linking of an ITN pool ticker with its counterpart in Mainnet to identify fraudulent duplicates. (already used as not standardized extension) - the **pool** section contains additional information about the pool instance -- the **operator** section contains additional information about the people operating this pool -- the **owner** section contains additional information about the pool owner(s) - - - -ToDo: describe the initial basic format, and a standard on how future CIPs need to approach an evolution of the extended metadata schema + - the pool.**contact** section contains information for additional information and contact data + - the pool.**media_assets** section contains additional information about the pools media files and colors + - the pool.**itn** section is an optional section for ITN pool operators #### Extended Metadata Schema +```json +{ + "$id": "http://example.com/example.json", + "$schema": "http://json-schema.org/draft-07/schema", + "default": {}, + "description": "additional information for Cardano Stake Pools", + "examples": [ + { + "serial": 2020072001, + "pool": { + "id": "0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f0f", + "country": "DE", + "status": "act", + "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": 48, + "minLength": 48, + "examples": [ "69579373ec20f2f82d2dc2360410350b308112f2939f92a" ] + }, + "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": 3, + "minLength": 3, + "examples": [ "JPN" ], + "title": "declared pool location", + "type": "string" + }, + "status": { + "$id": "#/properties/pool/properties/status", + "default": "", + "maxLength": 3, + "minLength": 3, + "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 prefered 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": "(shoud 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..." ] + } + } + } + } + } + } +} ``` -work in progress -``` - - -#### Infrastructure Mapping -``` -[ - {"Code": "aws", "Name": "Amazon Cloud"}, - {"Code": "google", "Name": "Google Cloud"}, - {"Code": "azure", "Name": "Microsoft Cloud"}, - {"Code": "digitalocean", "Name": "Digital Ocean"}, - {"Code": "baremetall", "Name": "Bare Metal Server(local)"}, - {"Code": "baremetalh", "Name": "Bare Metal Server(hosted)"}, - {"Code": "ovh", "Name": "OVH Cloud"}, - {"Code": "hetzner", "Name": "Hetzner"}, - {"Code": "vultr", "Name": "Vultr"}, - {"Code": "godaddy", "Name": "Go Daddy"}, - {"Code": "aruba", "Name": "Aruba"}, - {"Code": "hostinger", "Name": "Hostinger"}, - {"Code": "othervps", "Name": "Other VPS"}, - {"Code": "lpcsbc", "Name": "Low Power/Cost SBC (pi, rockspi, etc)"}, - {"Code": "undisclosed", "Name": "Undisclosed"} -] +### JSON example + +```json +{ + "serial": 870, + "pool": { + "id": "69579373ec20f2f82d2dc2360410350b308112f2939f92a", + "country": "JPN", + "status": "active", + "contact": { + "primary": "email", + "email": "info@demopool.org", + "facebook": "demopool12", + "github": "demopooldev", + "feed": "https://www.demopool.org/feed.xml", + "telegram": "demopool", + "twitter": "demopoolbird" + }, + "media_assets": { + "icon_png_64x64": "https://www.demopool.org/media/icon64.png", + "logo_png": "https://www.demopool.org/media/logo.png", + "logo_svg": "https://www.demopool.org/media/logo.svg", + "color_fg": "#AABBCC", + "color_bg": "#C0C0C0" + }, + "itn": { + "owner": "ed25519_pk1...", + "witness": "ed25519_sig1..." + } + } +} ``` -#### Operating System Mapping -``` -[ - {"Code": "linux", "Name": "Linux"}, - {"Code": "osx", "Name": "Apple OSX"}, - {"Code": "win", "Name": "Windows"}, - {"Code": "freebsd", "Name": "FreeBSD"}, - {"Code": "undisclosed", "Name": "Undisclosed"} -] -``` -#### Pool Status Mapping -``` -[ - {"Code": "act","Name": "Active"}, - {"Code": "ret","Name": "Retired"}, - {"Code": "off","Name": "Offline for Maintenance"}, - {"Code": "exp","Name": "Experimental"}, - {"Code": "dnu","Name": "Do Not Delegate To This Pool"} -] -``` + ## Backwards compatibility No fields are removed or changed in the current on chain metadata. The new `ext...` fields are optional and not necessary to parse for any entities that do not need additional information about a pool