Skip to content

Commit

Permalink
remove identity commands from cli (#343)
Browse files Browse the repository at this point in the history
### Description

As proposed in https://forum.celo.org/c/announcements/5 we are removing
these identity related commands.

Wait to merge till October

### Tested

n.a
### Related issues

- Fixes celo-org/celo-blockchain-planning#432
### Backwards compatibility

a breaking change

### Documentation

hopefully not

<!-- start pr-codex -->

---

## PR-Codex overview
This PR focuses on the removal of the `identity:identifier` and
`identity:get-attestations` commands from the CLI, along with updates to
the documentation reflecting these changes.

### Detailed summary
- Deleted files: 
  - `packages/cli/src/commands/identity/identifier.ts`
  - `packages/cli/src/commands/identity/get-attestations.ts`
  - `packages/cli/src/commands/identity/get-attestations.test.ts`
- Updated `docs/command-line-interface/identity.md` to remove references
to the deleted commands.
- Added a note about the deprecation of these commands with a link to
the relevant forum discussion.

> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`

<!-- end pr-codex -->
  • Loading branch information
aaronmgdr authored Oct 2, 2024
1 parent 4ef76eb commit 54741cc
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 316 deletions.
8 changes: 8 additions & 0 deletions .changeset/moody-falcons-remain.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
'@celo/celocli': major
---
Remove commands identity:identifier, identity:get-attestations

See https://forum.celo.org/t/rfc-deprecation-of-celocli-identity-commands/8676


85 changes: 0 additions & 85 deletions docs/command-line-interface/identity.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,93 +3,8 @@

Interact with ODIS and the attestations service

* [`celocli identity:get-attestations`](#celocli-identityget-attestations)
* [`celocli identity:identifier`](#celocli-identityidentifier)
* [`celocli identity:withdraw-attestation-rewards`](#celocli-identitywithdraw-attestation-rewards)

## `celocli identity:get-attestations`

Looks up attestations associated with the provided phone number. If a pepper is not provided, it uses the --from account's balance to query the pepper.

```
USAGE
$ celocli identity:get-attestations [--gasCurrency
0x1234567890123456789012345678901234567890] [--globalHelp] [--phoneNumber <value>]
[--from 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d] [--pepper <value>] [--identifier
<value>] [--network <value>]
FLAGS
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d Account whose balance to use
for querying ODIS for the
pepper lookup
--gasCurrency=0x1234567890123456789012345678901234567890 Use a specific gas currency
for transaction fees
(defaults to CELO if no gas
currency is supplied). It
must be a whitelisted token.
--globalHelp View all available global
flags
--identifier=<value> On-chain identifier
--network=<value> The ODIS service to hit:
mainnet, alfajores,
alfajoresstaging
--pepper=<value> ODIS phone number pepper
--phoneNumber=<value> Phone number to check
attestations for
DESCRIPTION
Looks up attestations associated with the provided phone number. If a pepper is not
provided, it uses the --from account's balance to query the pepper.
EXAMPLES
get-attestations --phoneNumber +15555555555 --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95
get-attestations --phoneNumber +15555555555 --pepper XgnKVpplZc0p1
get-attestations --identifier 0x4952c9db9c283a62721b13f56c4b5e84a438e2569af3de21cb3440efa8840872
```

_See code: [src/commands/identity/get-attestations.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/identity/get-attestations.ts)_

## `celocli identity:identifier`

Queries ODIS for the on-chain identifier and pepper corresponding to a given phone number.

```
USAGE
$ celocli identity:identifier --from 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d
--phoneNumber +14152223333 [--gasCurrency
0x1234567890123456789012345678901234567890] [--globalHelp] [--context <value>]
FLAGS
--context=<value> mainnet (default),
alfajores, or
alfajoresstaging
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d (required) The address from
which to perform the query
--gasCurrency=0x1234567890123456789012345678901234567890 Use a specific gas currency
for transaction fees
(defaults to CELO if no gas
currency is supplied). It
must be a whitelisted token.
--globalHelp View all available global
flags
--phoneNumber=+14152223333 (required) The phone number
for which to query the
identifier. Should be in
e164 format with country
code.
DESCRIPTION
Queries ODIS for the on-chain identifier and pepper corresponding to a given phone
number.
EXAMPLES
identifier --phoneNumber +14151231234 --from 0x5409ed021d9299bf6814279a6a1411a7e866a631 --context alfajores
```

_See code: [src/commands/identity/identifier.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/identity/identifier.ts)_

## `celocli identity:withdraw-attestation-rewards`

Withdraw accumulated attestation rewards for a given currency
Expand Down
62 changes: 0 additions & 62 deletions packages/cli/src/commands/identity/get-attestations.test.ts

This file was deleted.

106 changes: 0 additions & 106 deletions packages/cli/src/commands/identity/get-attestations.ts

This file was deleted.

63 changes: 0 additions & 63 deletions packages/cli/src/commands/identity/identifier.ts

This file was deleted.

0 comments on commit 54741cc

Please sign in to comment.