Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update develop/cli #26

Merged
merged 8 commits into from
Nov 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
126 changes: 44 additions & 82 deletions docs/develop/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,153 +30,115 @@ mycel start

## Transactions

### register-domain
### register-top-level-domain

Register domain to mycel
Registers a new top-level domain:

```
myceld tx registry register-domain [name] [parent] [registration-period-in-year]
myceld tx registry register-top-level-domain [name] [registration-period-in-year]
```

### update-wallet-record
### register-second-level-domain

Update wallet address record
Registers a new second-level domain under a specified parent domain:

```
myceld tx registry update-wallet-record [name] [parent] [wallet-record-type] [value]
myceld tx registry register-second-level-domain [name] [parent] [registration-period-in-year]
```

### update-dns-record
### update-wallet-record

Update DNS record
Updates the wallet address record for a domain:

```
myceld tx registry update-dns-record [name] [parent] [dns-record-type] [value]
myceld tx registry update-wallet-record [name] [parent] [wallet-record-type] [value]
```

## Queries

### list-second-level-domain
### update-dns-record

List all SLD domains
Updates the DNS record for a domain:

```
myceld q regisry list-second-level-domain
myceld tx registry update-dns-record [name] [parent] [dns-record-type] [value]
```

An example output:
### withdraw-registration-fee

Withdraws the registration fee for an owned domain:

```
domain:
- DNSRecords: {}
expirationDate: "0"
metadata: {}
name: cel
owner: ""
parent: ""
walletRecords: {}
- DNSRecords: {}
expirationDate: "1711123442987026000"
metadata: {}
name: foo
owner: cosmos1tk8gg20pcdp9alnnn6a84tdycf7pa2rjg8kwmc
parent: cel
walletRecords: {}
pagination:
next_key: null
total: "0"
myceld tx registry withdraw-registration-fee [name]
```

### show-second-level-domain
### extend-top-level-domain-expiration-date

Query domain records by domain
Extends the expiration date of a top-level domain:

```
myceld q regisry show-second-level-domain [name] [parent]
myceld tx registry extend-top-level-domain-expiration-date [name] [extension-period-in-year]
```

exmaple:
Query `foo.cel`
## Queries

```
myceld q registry show-domain foo cel
```
### list-top-level-domain

Output:
Displays a list of all registered top-level domains:

```
domain:
DNSRecords: {}
expirationDate: "1711123442987026000"
metadata: {}
name: foo
owner: cosmos1tk8gg20pcdp9alnnn6a84tdycf7pa2rjg8kwmc
parent: cel
walletRecords:
ETHEREUM_MAINNET:
WalletAddressFormat: ETHEREUM
value: 0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
walletRecordType: ETHEREUM_MAINNET
myceld query registry list-top-level-domain
```

### list-domain-ownership
### list-second-level-domain

List all domain ownership
Displays a list of all registered second-level domains:

```
myceld q registry list-domain-ownership
myceld q regisry list-second-level-domain
```

### show-domain-ownership
### show-top-level-domain

Query domain ownership by owner
Queries domain records by a specified top-level domain name:

```
myceld q registry show-domain-ownership [owner]
myceld q registry show-top-level-domain [tld name]
```

### domain-registration-fee
### show-second-level-domain

Query domain registration fee
Queries domain records by a specified second-level domain name and its parent:

```
myceld q registry domain-registration-fee [name] [parent]
myceld q regisry show-second-level-domain [sld name] [parent domain]
```

Response:
exmaple:
Query `foo.cel`

```
fee:
amount: string
myceld q regisry show-second-level-domain foo cel
```

### is-registrable-domain

Query a domain is registrable

```
myceld q registry is-registrable-domain [name] [parent]
```
### list-domain-ownership

Response:
Displays a list of all domain ownerships:

```
errorMessage: string
isRegstrable: bool
myceld q registry list-domain-ownership
```

### domain-registration-fee
### show-domain-ownership

Query domain regsitration fee
Queries domain ownership by the owner's address:

```
myceld query registry domain-registration-fee [name] [parent]
myceld q registry show-domain-ownership [owner]
```

### is-registrable-domain
### domain-registration-fee

Query a domain is registrable
Queries the registration fee for a domain:

```
myceld query registry is-registrable-domain [name] [parent]
myceld q registry domain-registration-fee [name] [parent] [registration-period-in-year]
```
Loading