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.

Sign up for GitHub

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

feat(blockchainAPI): adding optional chainId parameter for the identity #253

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+12 −7
Open

feat(blockchainAPI): adding optional chainId parameter for the identity #253

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de2d482
feat(blockchainAPI): optional chainId for the identity
geekbrother Sep 3, 2024
0878127
fix: removing ENS from the identity
geekbrother Sep 3, 2024
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
19 changes: 12 additions & 7 deletions docs/specs/servers/blockchain/blockchain-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
# Blockchain API

## Identity ENS lookups
## Identity name lookups

### ENS Name lookup
### Name lookup

Used to lookup name and avatar for the provided address.

Used to lookup ENS name and avatar for the Ethereum address.
`GET /v1/identity/{address}`

`GET /v1/identity/{address}?projectId={projectId}`
* `address` - The address to lookup for the name and avatar.

#### Query parameters:

* `address` - (Optional) Ethereum address to lookup for the ENS name and avatar.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixing this, address is not an optional parameter but is required.

* `projectId` - The project identifier.
* `chainId` - (Optional) CAIP-2 chain identifier to use for the address.
If it's not set the Ethereum mainnet and ENS resolution is used.
Comment on lines +16 to +17
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Clearly specifies the default. ENS resolution is unrelated

Suggested change
* `chainId` - (Optional) CAIP-2 chain identifier to use for the address.
If it's not set the Ethereum mainnet and ENS resolution is used.
* `chainId` - (Optional) CAIP-2 chain identifier to use for the address. Defaults to `eip155:1`


#### Success response body:

Expand All @@ -20,12 +25,12 @@ Used to lookup ENS name and avatar for the Ethereum address.
}
```

* `name` - Registered address ENS name.
* `name` - Registered address for the name.
* `avatar` - URI of the avatar of presented.

#### Response error codes:

* `400 Bad request` - Wrong requested address format.
* `400 Bad request` - Wrong requested address format or unsupported chain ID.

## Hexless account profiles API

Expand Down