Skip to content
This repository was archived by the owner on Feb 11, 2023. It is now read-only.
This repository was archived by the owner on Feb 11, 2023. It is now read-only.

[Feature] SDK for creating and reading hypercerts #1

Description

@bitbeckers

Goal

  • Typed
  • JSON specification metadata (supporting both structured and unstructured data. Structured should be required)
  • Graph client for Indexer
  • Validity checking of metadata
  • Managing IPFS state
  • Interacting with (typed) contracts

User stories

  • As a developer, I want to be able to pull the SDK from npm so I can create a new hypercert
  • As a developer, I want to be able to pull the SDK from npm so I can query hypercerts for display
  • As a developer, I want to be able to pull the SDK from npm so I can validate user input again the metadata schema
  • As a developer, I want to be able to pull the SDK from npm so I can generate metadata for a hypercert, including the image

Technical

  • Autopublish contract types via protocol repo to npm, load contract types in SDK via dependencies
  • packages monorepo managed via Lerna
  • GitHub Action to publish SDK on npm when creating release
  • documentation per package in README
  • CI/CD for testing package build
  • no web3 provider in the box, but require a provider for mutations

Interface

Metadata

  • generate()
  • store()
  • read()

Hypercerts

  • mint()

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

Type

No type

Projects

Relationships

None yet

Development

No branches or pull requests

Issue actions