Giter Club home page Giter Club logo

yearn-vault-schema's Introduction

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)

Validating the JSON Schema

yarn run test

Authoring token lists

Semantic versioning

The Vault Lists include a version field, which follows semantic versioning.

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

License

ISC - CC0-1.0

yearn-vault-schema's People

Watchers

 avatar  avatar  avatar  avatar

yearn-vault-schema's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.