{"id":20415757,"url":"https://github.com/unstoppabledomains/zns","last_synced_at":"2025-04-12T17:06:44.419Z","repository":{"id":38808147,"uuid":"150772856","full_name":"unstoppabledomains/zns","owner":"unstoppabledomains","description":"Zilliqa Naming Service","archived":false,"fork":false,"pushed_at":"2023-07-18T20:16:49.000Z","size":1199,"stargazers_count":30,"open_issues_count":7,"forks_count":8,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-03-26T11:21:29.967Z","etag":null,"topics":["blockchian","domain","name-service","scilla","unstoppable","zilliqa","zns"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/unstoppabledomains.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-09-28T17:21:43.000Z","updated_at":"2025-03-17T22:47:18.000Z","dependencies_parsed_at":"2022-09-05T13:10:34.601Z","dependency_job_id":null,"html_url":"https://github.com/unstoppabledomains/zns","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unstoppabledomains%2Fzns","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unstoppabledomains%2Fzns/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unstoppabledomains%2Fzns/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unstoppabledomains%2Fzns/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unstoppabledomains","download_url":"https://codeload.github.com/unstoppabledomains/zns/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248602302,"owners_count":21131615,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blockchian","domain","name-service","scilla","unstoppable","zilliqa","zns"],"created_at":"2024-11-15T06:17:27.600Z","updated_at":"2025-04-12T17:06:44.399Z","avatar_url":"https://github.com/unstoppabledomains.png","language":"TypeScript","readme":"# ZNS\n\nThe Zilliqa Name Service (ZNS) is a suite of smart contracts to make a naming\nsystem like DNS on the blockchain. ZNS connects the familiar and powerful name\nsystem mechanics to blockchain assets like addresses, websites and application\ndata, as well as traditional dns records.\n\n## Getting Started\n\n### Requirements\n\n- [Docker](https://www.docker.com) required\n- Node.js and Yarn are required as well.\n\n### Installing\n\n```sh\nyarn install\n```\n\n### Testing\n\nTests run against standalone zilliqa development node. You will need to install\n[Docker](https://www.docker.com) before.\n\n#### Run zilliqa development node\n\n\u003e Note: don't forget to perform `docker login` to be able to pull\n\u003e `unstoppabledomains/zilliqa-dev-node` image\n\n```shell script\nyarn zilliqa:start\n```\n\nIt's requires keep port `5555` open on local machine. If port already occupied -\nyou may have `zilliqa-dev-node` already run. You can check this via command\nbelow.\n\n#### Check node status\n\n```shell script\ndocker ps\n```\n\nYou should see similar output if node was ran. Almost each docker command\nrequires `CONTAINER ID`. Container id generates automatically on each\n`docker run`:\n\n```\nCONTAINER ID        IMAGE                     COMMAND                  CREATED             STATUS              PORTS                    NAMES\n3ab2b677fd8f        us-central1-docker.pkg... \"/usr/local/bin/isol…\"   11 minutes ago      Up 11 minutes       0.0.0.0:5555-\u003e5555/tcp   mystifying_wright\n```\n\n#### Run test suite\n\n```\nyarn test\n```\n\n#### Stop zilliqa development node\n\n```shell script\nyarn zilliqa:stop\n```\n\n#### Get logs from zilliqa development node\n\n```shell script\ndocker logs \u003cCONTAINER ID\u003e\n```\n\n#### Run node in foreground to get real-time logs on screen\n\n```shell script\ndocker run -p 5555:5555 us-central1-docker.pkg.dev/unstoppable-domains/zilliqa/zilliqa-dev-node\n```\n\n## Build zilliqa-dev-node\n\nYou may need to rebuild docker image for `zilliqa development node`.\n\n```shell script\ncd docker/build\ndocker build . -t zilliqa-dev-node\n```\n\nAnd run your brand new docker image:\n\n```shell script\ndocker run -p 5555:5555 zilliqa-dev-node\n```\n\n## Push new zilliqa-dev-node image\n\nTo build \u0026 push a new version of node image use `Build \u0026 Push Zilliqa Dev Node`\nGitHub Action.\n\nFor an introduction to Zilliqa and Scilla and some of the design considerations\nlook at the [Zilliqa Reference](./ZILLIQA.md).\n\nThere are 3 ZNS contract variants.\n\n- Registry – This contract where the ZNS names are stored. Registry mechanics\n  are explained in detail in the [Registry Reference](./REGISTRY.md).\n\n- Resolvers – In order to keep the size of the main ZNS contract low, the ZNS\n  resolution is stored in separate contracts called Resolvers. Resolvers\n  mechanics are explained in detail in the\n  [Resolvers Reference](./RESOLVERS.md).\n\n- Registrars – These contracts manage the registration of new ZNS names. ZNS has\n  2 of them. An auction registrar, which implements open, ascending price,\n  variable length auction. And a simple registrar listing all names for a fixed\n  price designed to be put in place after the initial auction period. Registrar\n  mechanics are explained in detail in the\n  [Registrar Reference](./REGISTRAR.md).\n\n## License\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funstoppabledomains%2Fzns","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funstoppabledomains%2Fzns","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funstoppabledomains%2Fzns/lists"}