Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unstoppabledomains/resolution-cli
CLI tool for resolving unstoppable domains
https://github.com/unstoppabledomains/resolution-cli
crypto unstoppable-domains zilliqa
Last synced: about 2 months ago
JSON representation
CLI tool for resolving unstoppable domains
- Host: GitHub
- URL: https://github.com/unstoppabledomains/resolution-cli
- Owner: unstoppabledomains
- License: mit
- Created: 2021-03-05T01:35:05.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-10-11T21:32:22.000Z (12 months ago)
- Last Synced: 2024-07-27T05:32:41.071Z (about 2 months ago)
- Topics: crypto, unstoppable-domains, zilliqa
- Language: Go
- Homepage:
- Size: 312 KB
- Stars: 26
- Watchers: 14
- Forks: 5
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# resolution-cli
[](https://goreportcard.com/report/github.com/unstoppabledomains/resolution-cli)
[](https://pkg.go.dev/github.com/unstoppabledomains/resolution-cli)
[](https://docs.unstoppabledomains.com/)
[](https://discord.gg/b6ZVxSZ9Hn)
Simple CLI tool for resolving Unstoppable domains
resolution-cli is a tool for interacting with blockchain domain names. It can be used to retrieve [payment addresses](https://unstoppabledomains.com/features#Add-Crypto-Addresses), IPFS hashes for [decentralized websites](https://unstoppabledomains.com/features#Build-Website), DNS records and other [records types](https://docs.unstoppabledomains.com/domain-registry-essentials/records-reference)
resolution-cli is primarily built and maintained by [Unstoppable Domains](https://unstoppabledomains.com/).
resolution-cli supports decentralized domains across two zones:
- Crypto Name Service (UNS)
- `.crypto`
- `.coin`
- `.wallet`
- `.bitcoin`
- `.x`
- `.888`
- `.nft`
- `.dao`
- Zilliqa Name Service (ZNS)
- `.zil`
# Quick Start
## Download binaries from release pages
[Find binary on releases page](https://github.com/unstoppabledomains/resolution-cli/releases)
## Installation using go
```shell
go get -u github.com/unstoppabledomains/resolution-cli/resolution
```
### Build and install from sources
```shell
go build -o ./cli ./resolution
mv ./cli /usr/local/bin/resolution
```
## Run
```shell
resolution --help
```
### Ethereum Provider
UNS domains are resolved by reading from both the Ethereum mainnet and Polygon L2 network.
If L1 and L2 Ethereum JSON RPC are not defined, default Infura Ethereum Provider Urls for L1 and L2 will be used.
NOTE: L1 and L2 networks must both be defined or none at all.
#### L1
Options for defining a custom Ethereum provider:
- `RESOLUTION_ETHEREUM_PROVIDER_URL` env variable to specify the provider URL
- `RESOLUTION_ETHEREUM_NETWORK_ID` env variable to specify the network type (mainnet or rinkeby)
- `--ethereum-provider-url` flag to specify the provider URL
- `--ethereum-network-id` flag to specify the network type (mainnet or rinkeby)
The CLI prioritizes the `--ethereum-provider-url` and `--ethereum-network-id` flags
#### L2
Options for defining a custom Polygon L2 provider:
- `RESOLUTION_ETHEREUM_L2_PROVIDER_URL` env variable to specify the provider URL
- `RESOLUTION_ETHEREUM_L2_NETWORK_ID` env variable to specify the network type (polygon or matic)
- `--ethereum-l2-provider-url` flag to specify the provider URL
- `--ethereum-l2-network-id` flag to specify the network type (polygon or matic)
The CLI prioritizes the `--ethereum-l2-provider-url` and `--ethereum-l2-network-id` flags
### Zilliqa Provider
If no Ethereum JSON RPC ethereum-provider-url is defined, a default Zilliqa mainnet Provider Url will be used
Options for defining a ethereumProviderUrlFlag:
- `ZILLIQA_PROVIDER_URL` env variable
- `--zilliqa-provider-url` flag
The CLI prioritizes the `--zilliqa-provider-url` flag
# Resolve a Domain
## Address
Resolve single address from ticker symbol
```shell
resolution resolve addr ETH -d brad.crypto
```
## IPFS
Resolve ipfs hash
```shell
resolution resolve ipfs-hash -d brad.zil
```
## All
Resolve all known records
```shell
resolution resolve -d brad.zil
```
## Raw records
Resolve records from exact record keys. See supported records reference [here](https://docs.unstoppabledomains.com/domain-registry-essentials/records-reference)
```shell
resolution resolve records crypto.ETH.adddress crypto.BTC.address -d brad.crypto
```
# Output format
CLI provides JSON output or quoted string in case of single return value
# Network support
CLI supports Ethereum, Polygon, and Zilliqa mainnet only.
# Contributions
Contributions are more than welcome. The easiest way to contribute is through GitHub issues and pull requests.
# Development
## Run end-to-end tests
```shell
bash run-e2e-test.sh
```
## Build binaries for Windows, MacOS and Linux
```shell
bash build-binaries.sh
```
Find the binaries in `./build` directory
**Note: Each new release should include these binaries attached**
# Free advertising for integrated apps
Once your app has a working Unstoppable Domains integration, [register it here](https://unstoppabledomains.com/app-submission). Registered apps appear on the Unstoppable Domains [homepage](https://unstoppabledomains.com/) and [Applications](https://unstoppabledomains.com/apps) page — putting your app in front of tens of thousands of potential customers per day.
Also, every week we select a newly-integrated app to feature in the Unstoppable Update newsletter. This newsletter is delivered to straight into the inbox of ~100,000 crypto fanatics — all of whom could be new customers to grow your business.
# Get help
[Join our discord community](https://discord.com/invite/b6ZVxSZ9Hn) and ask questions.