{"_id":"@0xsequence/collectible-lists","_rev":"9-41bb0e37f53fe9115dcbe6f283becd8c","name":"@0xsequence/collectible-lists","dist-tags":{"latest":"1.1.0"},"versions":{"1.0.0":{"name":"@0xsequence/collectible-lists","version":"1.0.0","author":{"name":"Philippe Castonguay"},"license":"MIT","_id":"@0xsequence/collectible-lists@1.0.0","maintainers":[{"name":"phabc","email":"ph.castonguay@gmail.com"},{"name":"pkieltyka","email":"pk@horizon.io"}],"homepage":"https://github.com/0xsequence/collectible-lists#readme","bugs":{"url":"https://github.com/0xsequence/collectible-lists/issues"},"dist":{"shasum":"438495921007ab95b74898d1e96b401f46abf261","tarball":"https://registry.npmjs.org/@0xsequence/collectible-lists/-/collectible-lists-1.0.0.tgz","fileCount":27,"integrity":"sha512-QpKn/t2wzuYjqEGxb2q8oashTjmeH1zkPhvejJr48Gr8rYk8nIN6tkEU+gSIZ6lPsH/gsw9+DMo4fm1QigY7HA==","signatures":[{"sig":"MEYCIQD9QR/k3CzVuC3DOyJBMxpdslTTYxqm7FMhaJrUAce5QwIhAKBAsU49SspL/bViULGqwEBc9DL3jsbr8rp8cMOrAEJq","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":99047,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgCakUCRA9TVsSAnZWagAAz7kQAJqVroWMPT4K5ujpWUK8\nmbCAiy2wTgnb0ye1aqsNlY9h+B8RXBHeigvLypOk/XDThYV+hSmRat8+SUXu\nS6DHMRFI1rpU/7UFHe2fHkgFcwwxBwlexjNKxQBYPry9j5nhHCPuZeZYMV0b\nWlh+etSxdt+KSvHFWAPr2jopkdLupwEBL8c56YIurFTSEhBnbhh2E2zjW6kU\nYhiFzGnvD/Y+H5bEzhiRTUmO/8MnGcd4XhO8hj1X6JvLj3Yf5oA4yoL1zYCO\nTcKQnZdh2pC+EglihY1gOQS5sLc4MTpJQZvp4rlmE7Lwb3C3TW7WWiGOT8/2\nALu1CCVOEzIoavMP0qUMeUqQ2K6sGBoL5DuE6I/MMa3GtfP9zQVHUcIhs+8h\nUfHhyfNZ9VMxWNEDcohZdoZR2mq3rZxSbo+kAmUEpXoHEwzTGof24K+J4z7i\n/woiu6Lyg2QrKogS/HuQR87j0gok4e7z/Nhe3dzKXZ1gCCAYhBIVjOKBwvdw\n6h1xt27L7f85rTkZbOShjbc3hNTmmswOKQ0XOr0ptPlauijf1O14FGedl3ro\nGbnROKw2OcNHQyLr6WFSnILLwGvdOb1k6zL9H2OeNxvQg7D5azSwqp2SPAFe\nhlErk/cSIZqzh18CXgjc+K76ce0kQuat79fXDV9YMiw19U9HAadkVB0tPrqv\n5PPm\r\n=1joF\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"tsdx lint"}},"module":"dist/collectible-lists.esm.js","engines":{"node":">=10"},"gitHead":"6bab40f5d99318a15af60eb7e14343582e1e4f1e","scripts":{"lint":"tsdx lint","test":"tsdx test","build":"tsdx build","start":"tsdx watch","prepublishOnly":"tsdx test && tsdx build"},"typings":"dist/index.d.ts","_npmUser":{"name":"phabc","email":"ph.castonguay@gmail.com"},"prettier":{"semi":true,"printWidth":80,"singleQuote":true,"trailingComma":"es5"},"repository":{"url":"git+https://github.com/0xsequence/collectible-lists.git","type":"git"},"_npmVersion":"6.14.6","description":"📚 The Collectible Lists specification","directories":{},"_nodeVersion":"12.18.3","_hasShrinkwrap":false,"devDependencies":{"ajv":"^6.12.2","tsdx":"^0.14.0","husky":"^4.2.5","tslib":"^2.0.0","typescript":"^3.9.5"},"peerDependencies":{},"_npmOperationalInternal":{"tmp":"tmp/collectible-lists_1.0.0_1611245836487_0.24977903277711166","host":"s3://npm-registry-packages"}},"1.1.0":{"name":"@0xsequence/collectible-lists","version":"1.1.0","author":{"name":"Philippe Castonguay"},"license":"MIT","_id":"@0xsequence/collectible-lists@1.1.0","maintainers":[{"name":"phabc","email":"ph.castonguay@gmail.com"},{"name":"pkieltyka","email":"pk@horizon.io"}],"homepage":"https://github.com/0xsequence/collectible-lists#readme","bugs":{"url":"https://github.com/0xsequence/collectible-lists/issues"},"dist":{"shasum":"bc11de94e69f69051565edab70f4546b4cad9438","tarball":"https://registry.npmjs.org/@0xsequence/collectible-lists/-/collectible-lists-1.1.0.tgz","fileCount":27,"integrity":"sha512-fnZkRJs8zrpFXXcGgBbhxAehXN+lpzkgCA/okqCCUsFR12TcmWTW7BsSn89PakFnuiN7fawCssl6XtqvlQSiew==","signatures":[{"sig":"MEQCIArA0d62KapjzHnjpQXEdF3+sZn1rtEeNQqy0+LH0EuVAiBsw/8xqeUJ01T9P+Vq+t0wpz2g/8Fj2tX1fldNFcHXVQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":99070,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgCf+fCRA9TVsSAnZWagAAV5UP/RVkV+LFLJ3Q2FV0jWXR\n8HEU3r3QylrrD/b2K3AcMCsGV9sh3QsSdwF4G76mwAwHxHRGr2tzkwzNkODZ\nDRXXrnzNPtx5X3TYjjmhiVcOCNrmwX6hDCZ8H1OXa7NISlChfOGuXL0GBKNS\nHXGF4d15lt9a3WW/gJNpYqpJJD3Le60FyoFENMXOVIomr7Kc1ybcNA6x0z/p\nlVIbyIvF9D5jySgKx+PrpTEfXm1fl8AmcrMgqTW5Hcu4MadgIm7lAOcnNd4P\nmJHc2j12arSEbnGXxiKky+T+VjNFO7vJsYpTrKxXSq5DwMNwrD5WWez2hsjx\nYiHQ9yVvW0ak741UyG52NnOz6LJGNlg7JJWdSMm/T+y6U1K71gqesE895h4f\nwMcKMmytfkGhux8vknnaatklioSh3DAdJIRUwq8axIiBiM8il9LK8QRcXS+y\nkg6vNmrB8AmqgXeVQeWPeBbfyllo2zr77RIzv6zSu7S3j+z1hvqgW8EmEbq8\n2hb+Fp/Qw3ifjs4THI1DYDytJObFLib8idkX6aiuzYH6VzOmyCtxW6aghH7K\nIlWNAWl2gH94hWwcWeCidBzUdQWCY0gJTLBpvKy0SHA8KlhAVLhTs/WFst5M\nwoSnwgo9agUoYm4vfW9zdeMuGutr0lhcMLZ5y3OW0zm2fOb7x4CpATyFdJXU\nmTxb\r\n=i2u9\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","husky":{"hooks":{"pre-commit":"tsdx lint"}},"module":"dist/collectible-lists.esm.js","engines":{"node":">=10"},"gitHead":"355d1fb1280cba02980abd399b471c290fca8b5f","scripts":{"lint":"tsdx lint","test":"tsdx test","build":"tsdx build","start":"tsdx watch","prepublishOnly":"tsdx test && tsdx build"},"typings":"dist/index.d.ts","_npmUser":{"name":"phabc","email":"ph.castonguay@gmail.com"},"prettier":{"semi":true,"printWidth":80,"singleQuote":true,"trailingComma":"es5"},"repository":{"url":"git+https://github.com/0xsequence/collectible-lists.git","type":"git"},"_npmVersion":"6.14.6","description":"📚 The Collectible Lists specification","directories":{},"_nodeVersion":"12.18.3","_hasShrinkwrap":false,"devDependencies":{"ajv":"^6.12.2","tsdx":"^0.14.0","husky":"^4.2.5","tslib":"^2.0.0","typescript":"^3.9.5"},"peerDependencies":{},"_npmOperationalInternal":{"tmp":"tmp/collectible-lists_1.1.0_1611267998637_0.7573113785648327","host":"s3://npm-registry-packages"}}},"time":{"created":"2021-01-21T16:17:16.192Z","modified":"2025-02-19T00:40:44.498Z","1.0.0":"2021-01-21T16:17:16.992Z","1.1.0":"2021-01-21T22:26:38.780Z"},"bugs":{"url":"https://github.com/0xsequence/collectible-lists/issues"},"author":{"name":"Philippe Castonguay"},"license":"MIT","homepage":"https://github.com/0xsequence/collectible-lists#readme","repository":{"url":"git+https://github.com/0xsequence/collectible-lists.git","type":"git"},"description":"📚 The Collectible Lists specification","maintainers":[{"email":"wh@horizongames.net","name":"naivesheep"},{"email":"pk@horizon.io","name":"pkieltyka"},{"email":"agusxrun@gmail.com","name":"agusx1211"},{"email":"taylan@hipolabs.com","name":"taylanpince"},{"email":"screaminghawk@gmail.com","name":"milkytaste"}],"readme":"# @0xsequence/collectible-lists (beta)\n[![npm](https://img.shields.io/npm/v/@0xsequence/collectible-lists)](https://unpkg.com/@0xsequence/collectible-lists@latest/)\n\nThis package includes a JSON schema for token lists, and TypeScript utilities for working with collectible lists.\n\nThe JSON schema represents the technical specification for a collectible list which can be used in a dApp interface, such as Opensea Interface.\n\n## What are collectible lists?\n\nSequence Collectible Lists is a specification for lists of collectible token metadata (e.g. address, name, ...) that can be used by any dApp interfaces that needs one or more lists of collectibles. This specification is a fork of https://github.com/Uniswap/token-lists for tokens that comply with the ERC-721 and ERC-1155 token standards.\n\nAnyone can create and maintain a collectible list, as long as they follow the specification. \n\nSpecifically an instance of a token list is a [JSON](https://www.json.org/json-en.html) blob that contains a list of \n[ERC-721](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-721.md) or [ERC-1155](https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1155.md) token metadata for use in dApp user interfaces.\n\nNotes:\n- Token list JSON must validate against the [JSON schema](https://json-schema.org/) in order to be used.\n- Tokens on collectible lists, and collectible lists themselves, are tagged so that users can more easily find collectibles.\n- Names of tokens are not validated against any pattern to allow token names in multiple languages. It's up to collectible list creators to ensure information integrity\n- Symbols of tokens are not validated against any pattern to allow token names in multiple languages. It's up to collectible list creators to ensure information integrity\n\n## JSON Schema $id\n\nThe JSON schema ID is [https://github.com/0xsequence/collectible-lists/blob/master/src/tokenlist.schema.json](https://github.com/0xsequence/collectible-lists/blob/master/src/tokenlist.schema.json).\n\n## Validating token lists\n\nThis package does not include code for token list validation. You can easily do this by including a library such as \n[ajv](https://ajv.js.org/) to perform the validation against the JSON schema. The schema is exported from the package\nfor ease of use.\n\n## Authoring token lists\n\n### Manual\n\nThe best way to manually author token lists is to use an editor that supports JSON schema validation. Most popular\ncode editors do, such as [IntelliJ](https://www.jetbrains.com/help/idea/json.html#ws_json_schema_add_custom) or \n[VSCode](https://code.visualstudio.com/docs/languages/json#_json-schemas-and-settings). Other editors\ncan be found [here](https://json-schema.org/implementations.html#editors).\n\nThe schema is registered in the [SchemaStore](https://github.com/SchemaStore/schemastore), and any file that matches\nthe pattern `*.tokenlist.json` should \n[automatically utilize](https://www.jetbrains.com/help/idea/json.html#ws_json_using_schemas) \nthe JSON schema for the [supported text editors](https://www.schemastore.org/json/#editors).\n\nIn order for your token list to be able to be used, it must pass all JSON schema validation.\n\n### Automated\n\nIf you want to automate token listing, e.g. by pulling from a smart contract, or other sources, you can use this\nnpm package to take advantage of the JSON schema for validation and the TypeScript types.\nOtherwise, you are simply working with JSON. All the usual tools apply, e.g.:\n\n```typescript\nimport { CollectibleList, schema } from '@0xsequence/collectible-lists'\n\n// generate your collectible list however you like.\nconst myList: CollectibleList = generateMyCollectibleList();\n\n// use a tool like `ajv` to validate your generated token list\nvalidateMyCollectibleList(myList, schema);\n\n// print the resulting JSON to stdout\nprocess.stdout.write(JSON.stringify(myList));\n```\n\n## Semantic versioning\n\nLists include a `version` field, which follows [semantic versioning](https://semver.org/).\n\nList versions must follow the rules:\n\n- Increment major version when tokens are removed\n- Increment minor version when tokens are added\n- Increment patch version when tokens already on the list have minor details changed (name, symbol, logo URL, metadataBaseURI)\n\nChanging a token address or chain ID is considered both a remove and an add, and should be a major version update.\n\nNote that list versioning is used to improve the user experience, but not for security, i.e. list versions are not meant\nto provide protection against malicious updates to a token list; i.e. the list semver is used as a lossy compression\nof the diff of list updates. List updates may still be diffed in the client dApp.\n\n## Deploying your list\n\nOnce you have authored the list, you can make it available at any URI. Prefer pinning your list to IPFS \n(e.g. via [pinata.cloud](https://pinata.cloud)) and referencing the list by an ENS name that resolves to the \n[contenthash](https://eips.ethereum.org/EIPS/eip-1577).\n\nIf hosted on HTTPS, make sure the endpoint is configured to send an access-control-allow-origin header to avoid CORS errors.\n\n### Linking an ENS name to the list\n\nAn ENS name can be assigned to an IPFS hash via the [contenthash](https://eips.ethereum.org/EIPS/eip-1577) text record.\nThis is the preferred way of referencing your list.\n\n## Examples\n\nYou can find a simple example of a token list in [test/schema/example.tokenlist.json](test/schema/example.tokenlist.json).\n\nA snapshot of the Sequence default list encoded as a token list is found in [test/schema/bigexample.tokenlist.json](test/schema/bigexample.tokenlist.json).\n","readmeFilename":"README.md"}