[{"data":1,"prerenderedAt":387},["Reactive",2],{"content-query-oEW4clMmfK":3},{"_path":4,"_dir":5,"_draft":6,"_partial":6,"_locale":7,"title":8,"description":9,"body":10,"_type":382,"_id":383,"_source":384,"_file":385,"_extension":386},"/docs/dev/confidential-assets/using-confidential-assets/asset-metadata-descriptor","using-confidential-assets",false,"","Asset Metadata Descriptor","This document's purpose is to specify the asset metadata, to enable 3rd party tools to consume and display the subset of asset-related information in a simple and well-standardized manner.",{"type":11,"children":12,"toc":372},"root",[13,21,28,34,102,108,113,126,131,138,228,233,332,338,346,355,363],{"type":14,"tag":15,"props":16,"children":18},"element","h1",{"id":17},"asset-metadata-descriptor",[19],{"type":20,"value":8},"text",{"type":14,"tag":22,"props":23,"children":25},"h2",{"id":24},"requirements",[26],{"type":20,"value":27},"Requirements",{"type":14,"tag":29,"props":30,"children":31},"p",{},[32],{"type":20,"value":33},"Asset meta is a byte buffer associated with the asset and stored on chain.",{"type":14,"tag":35,"props":36,"children":37},"ul",{},[38,44,64,92,97],{"type":14,"tag":39,"props":40,"children":41},"li",{},[42],{"type":20,"value":43},"Asset metadata should be an UTF-8 string",{"type":14,"tag":39,"props":45,"children":46},{},[47,49,56,58],{"type":20,"value":48},"Asset metadata should be serialized as a simple ",{"type":14,"tag":50,"props":51,"children":53},"code",{"className":52},[],[54],{"type":20,"value":55},"name=value",{"type":20,"value":57}," set of pairs, delimited with ",{"type":14,"tag":50,"props":59,"children":61},{"className":60},[],[62],{"type":20,"value":63},";",{"type":14,"tag":39,"props":65,"children":66},{},[67,69,75,77,83,85,90],{"type":20,"value":68},"The ",{"type":14,"tag":50,"props":70,"children":72},{"className":71},[],[73],{"type":20,"value":74},"keyN=valueN;",{"type":20,"value":76}," sequence must be preceded with ",{"type":14,"tag":50,"props":78,"children":80},{"className":79},[],[81],{"type":20,"value":82},"STD:",{"type":20,"value":84}," prefix, there is no need for ",{"type":14,"tag":50,"props":86,"children":88},{"className":87},[],[89],{"type":20,"value":63},{"type":20,"value":91}," at the sequence end",{"type":14,"tag":39,"props":93,"children":94},{},[95],{"type":20,"value":96},"The total size of the metadata cannot exceed 16 Kbytes (16,384 bytes)",{"type":14,"tag":39,"props":98,"children":99},{},[100],{"type":20,"value":101},"Every description should be in English",{"type":14,"tag":22,"props":103,"children":105},{"id":104},"properties",[106],{"type":20,"value":107},"Properties",{"type":14,"tag":29,"props":109,"children":110},{},[111],{"type":20,"value":112},"Asset metadata has 2 groups of properties:",{"type":14,"tag":35,"props":114,"children":115},{},[116,121],{"type":14,"tag":39,"props":117,"children":118},{},[119],{"type":20,"value":120},"Standard properties",{"type":14,"tag":39,"props":122,"children":123},{},[124],{"type":20,"value":125},"Optional properties",{"type":14,"tag":29,"props":127,"children":128},{},[129],{"type":20,"value":130},"Both types of properties are immutable and can't be changed after the asset is created. Therefore, double-checking the values before starting the asset registration is strongly recommended",{"type":14,"tag":132,"props":133,"children":135},"h3",{"id":134},"required-properties",[136],{"type":20,"value":137},"Required properties:",{"type":14,"tag":35,"props":139,"children":140},{},[141,158,175,194,211],{"type":14,"tag":39,"props":142,"children":143},{},[144,150,152],{"type":14,"tag":50,"props":145,"children":147},{"className":146},[],[148],{"type":20,"value":149},"SCH_VER=",{"type":20,"value":151}," metadata schema version currently must be ",{"type":14,"tag":50,"props":153,"children":155},{"className":154},[],[156],{"type":20,"value":157},"1",{"type":14,"tag":39,"props":159,"children":160},{},[161,167,169],{"type":14,"tag":50,"props":162,"children":164},{"className":163},[],[165],{"type":20,"value":166},"N=",{"type":20,"value":168}," human-readable asset name, for example ",{"type":14,"tag":50,"props":170,"children":172},{"className":171},[],[173],{"type":20,"value":174},"Beam Coin",{"type":14,"tag":39,"props":176,"children":177},{},[178,184,186,192],{"type":14,"tag":50,"props":179,"children":181},{"className":180},[],[182],{"type":20,"value":183},"SN=",{"type":20,"value":185}," human-readable short name/asset code, for example ",{"type":14,"tag":50,"props":187,"children":189},{"className":188},[],[190],{"type":20,"value":191},"BEAM",{"type":20,"value":193},". Length should not exceed 6 characters",{"type":14,"tag":39,"props":195,"children":196},{},[197,203,205],{"type":14,"tag":50,"props":198,"children":200},{"className":199},[],[201],{"type":20,"value":202},"UN=",{"type":20,"value":204}," human-readable asset unit name, for example ",{"type":14,"tag":50,"props":206,"children":208},{"className":207},[],[209],{"type":20,"value":210},"Beam",{"type":14,"tag":39,"props":212,"children":213},{},[214,220,222],{"type":14,"tag":50,"props":215,"children":217},{"className":216},[],[218],{"type":20,"value":219},"NTHUN=",{"type":20,"value":221}," human-readable smallest asset unit name (nth-unit name), for example ",{"type":14,"tag":50,"props":223,"children":225},{"className":224},[],[226],{"type":20,"value":227},"Groth",{"type":14,"tag":132,"props":229,"children":231},{"id":230},"optional-properties",[232],{"type":20,"value":125},{"type":14,"tag":35,"props":234,"children":235},{},[236,255,266,277,288,299,310,321],{"type":14,"tag":39,"props":237,"children":238},{},[239,245,247,253],{"type":14,"tag":50,"props":240,"children":242},{"className":241},[],[243],{"type":20,"value":244},"NTH_RATIO=",{"type":20,"value":246}," integer that represents the ratio of the smallest asset unit to regular unit. If omitted default value of ",{"type":14,"tag":50,"props":248,"children":250},{"className":249},[],[251],{"type":20,"value":252},"100000000",{"type":20,"value":254}," is used",{"type":14,"tag":39,"props":256,"children":257},{},[258,264],{"type":14,"tag":50,"props":259,"children":261},{"className":260},[],[262],{"type":20,"value":263},"OPT_SHORT_DESC=",{"type":20,"value":265}," an one-liner, should not exceed 128 characters",{"type":14,"tag":39,"props":267,"children":268},{},[269,275],{"type":14,"tag":50,"props":270,"children":272},{"className":271},[],[273],{"type":20,"value":274},"OPT_LONG_DESC=",{"type":20,"value":276}," a paragraph, should not exceed 1024 characters",{"type":14,"tag":39,"props":278,"children":279},{},[280,286],{"type":14,"tag":50,"props":281,"children":283},{"className":282},[],[284],{"type":20,"value":285},"OPT_SITE_URL=",{"type":20,"value":287}," URL of the asset website",{"type":14,"tag":39,"props":289,"children":290},{},[291,297],{"type":14,"tag":50,"props":292,"children":294},{"className":293},[],[295],{"type":20,"value":296},"OPT_PDF_URL=",{"type":20,"value":298}," URL for the description paper",{"type":14,"tag":39,"props":300,"children":301},{},[302,308],{"type":14,"tag":50,"props":303,"children":305},{"className":304},[],[306],{"type":20,"value":307},"OPT_FAVICON_URL=",{"type":20,"value":309}," URL of the favicon",{"type":14,"tag":39,"props":311,"children":312},{},[313,319],{"type":14,"tag":50,"props":314,"children":316},{"className":315},[],[317],{"type":20,"value":318},"OPT_LOGO_URL=",{"type":20,"value":320}," URL of the logo in SVG vector format",{"type":14,"tag":39,"props":322,"children":323},{},[324,330],{"type":14,"tag":50,"props":325,"children":327},{"className":326},[],[328],{"type":20,"value":329},"OPT_COLOR=",{"type":20,"value":331}," color in the hex format (#FF00FF for example) to be used by the UI to display this asset. If not specified default color would be generated. Currently default colors are based on the asset id",{"type":14,"tag":22,"props":333,"children":335},{"id":334},"examples",[336],{"type":20,"value":337},"Examples",{"type":14,"tag":35,"props":339,"children":340},{},[341],{"type":14,"tag":39,"props":342,"children":343},{},[344],{"type":20,"value":345},"with required properties only:",{"type":14,"tag":29,"props":347,"children":348},{},[349],{"type":14,"tag":50,"props":350,"children":352},{"className":351},[],[353],{"type":20,"value":354},"--asset_meta \"STD:SCH_VER=1;N=Beam Coin;SN=BEAM;UN=Beam;NTHUN=Groth\"",{"type":14,"tag":35,"props":356,"children":357},{},[358],{"type":14,"tag":39,"props":359,"children":360},{},[361],{"type":20,"value":362},"with required and optional properties:",{"type":14,"tag":29,"props":364,"children":365},{},[366],{"type":14,"tag":50,"props":367,"children":369},{"className":368},[],[370],{"type":20,"value":371},"--asset_meta \"STD:SCH_VER=1;N=Beam Coin;SN=BEAM;UN=Beam;NTHUN=Groth;NTH_RATIO=1000;OPT_SHORT_DESC=Off with their heads!;OPT_LONG_DESC=The fact that this catch phrase ... this story remains a part of popular culture.;OPT_SITE_URL=https://***/*;OPT_PDF_URL=https://***;OPT_FAVICON_URL=https://***/;OPT_LOGO_URL=https://***;OPT_COLOR=#FF00FF\" --fee 100000 --enable_assets",{"title":7,"searchDepth":373,"depth":373,"links":374},2,[375,376,381],{"id":24,"depth":373,"text":27},{"id":104,"depth":373,"text":107,"children":377},[378,380],{"id":134,"depth":379,"text":137},3,{"id":230,"depth":379,"text":125},{"id":334,"depth":373,"text":337},"markdown","docs:docs:dev:confidential-assets:using-confidential-assets:asset-metadata-descriptor.md","docs","docs/dev/confidential-assets/using-confidential-assets/asset-metadata-descriptor.md","md",1777630727421]