https://github.com/sambacha/yearn-vault-schema

The JSON schema represents the technical specification for yfi vaults - which can be used in in a RESTful API, dApp interface, etc.
https://github.com/sambacha/yearn-vault-schema

defi erc20 ethereum json json-schema yearn yfi

Last synced: 15 days ago
JSON representation

The JSON schema represents the technical specification for yfi vaults - which can be used in in a RESTful API, dApp interface, etc.

• Host: GitHub
• URL: https://github.com/sambacha/yearn-vault-schema
• Owner: sambacha
• Created: 2020-09-04T12:24:35.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-01-19T16:48:22.000Z (almost 4 years ago)
• Last Synced: 2024-12-13T01:46:16.329Z (16 days ago)
• Topics: defi, erc20, ethereum, json, json-schema, yearn, yfi
• Language: JavaScript
• Homepage:
• Size: 98.6 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# yfiVaultSchemas

> a JSON schema for yearn vaults

The JSON schema represents the technical specification for yfi vaults - which can be used in in a RESTful API, dApp interface, etc.

## Overview

**SEE** `schema.yif.json`

## Conventions

use `camelCase`

## JSON Schema \$id

The JSON schema ID is [schema.yfi.json](schema.yfi.json))

## Validating the JSON Schema

`yarn run test`

## Authoring token lists

## Semantic versioning

The Vault Lists include a `version` field, which follows [semantic versioning](https://semver.org/).

List versions must follow the rules:

- Increment major version when vaults are removed/migrated

- Increment minor version when vaults are added

- Increment patch version when vaults already on the list have minor details changed (name, symbol, logo URL, decimals)

Changing a token address or chain ID is considered both a remove and an add, and should be a major version update.

Note that list versioning is used to improve the user experience, but not for security, i.e. list versions are not meant to provide protection against malicious updates to a token list; i.e. the list semver is used as a lossy compression of the diff of list updates. List updates may still be diffed in the client dApp.

## Contributors

Thanks to `x48` for creating the original JSON file that this utilizes which can be accessed in [`/archive`](/archive)

## License

ISC - CC0-1.0