Skip to content

Add UI link for contract data viewing in API documentation and llms.txt #55

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

Open
marcocastignoli wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add UI link for contract data viewing in API documentation and llms.txt #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions docs/1. API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ The main Sourcify API for verification is `/v2/verify/{chainId}/{address}`, it e

Verified contracts data can be fetched using the `/v2/contract/{chainId}/{address}?fields=all` API. For the full list of fields and additional parameters please check the [documentation below](#server-api-documentation).

Contract data can also be viewed in the web application at https://repo.sourcify.dev/{chainId}/{address}. This URL is intended only for browsing contract data through the UI.

<Tabs>
<TabItem value="curl" label="curl">
```bash
Expand Down
10 changes: 9 additions & 1 deletion static/llms.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,12 @@ The `swagger.json` file above is structured as follows:

### To read smart contracts read

- paths["/v2/contract/{chainId}/{address}"].get
- paths["/v2/contract/{chainId}/{address}"].get

## Repository UI

Contract's data can be viewed in the web application at https://repo.sourcify.dev/{chainId}/{address}.

- Do not use this repository to retrieve individual files.
- LLMs should not use this repository for data exploration; use the API referenced above instead.
- You may share links to this repository with users who want to browse contract's data through the UI.