Skip to content

Commit 2b7e263

Browse files
Add llms.txt file (#52)
* Add llms.txt file * Fix title in llms.txt * add section "Check verification job status"
1 parent 1febd81 commit 2b7e263

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

static/llms.txt

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Sourcify
2+
3+
This file provides an overview of the Sourcify API documentation.
4+
5+
## Sourcify API versions:
6+
7+
- v1 (deprecated; don't use it)
8+
- v2 (preferred; choose this)
9+
10+
## API specification (use this URL):
11+
12+
https://sourcify.dev/server/api-docs/swagger.json
13+
14+
### How to read the swagger file
15+
16+
The `swagger.json` file above is structured as follows:
17+
18+
```json
19+
{
20+
"openapi": "OPENAPI_VERSION",
21+
"info": {
22+
"version": "SOURCIFY_VERSION",
23+
},
24+
"servers": [
25+
{ "url": "https://sourcify.dev/server", "description": "Production server" },
26+
...
27+
],
28+
"paths": {
29+
"SOURCIFY_API_PATH": {
30+
"HTTP_METHOD": { /* OPENAPI SPECIFICATIONS */ }
31+
}
32+
}
33+
}
34+
```
35+
36+
### To verify smart contracts read
37+
38+
- paths["/v2/verify/{chainId}/{address}"].post
39+
40+
### Check verification job status
41+
42+
- paths["/v2/verify/{verificationId}"].get
43+
44+
### To read smart contracts read
45+
46+
- paths["/v2/contract/{chainId}/{address}"].get

0 commit comments

Comments
 (0)