Skip to content
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.

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

Spec 3ID account package api #43

Closed
oed opened this issue Apr 20, 2020 · 0 comments
Closed

Spec 3ID account package api #43

oed opened this issue Apr 20, 2020 · 0 comments
Assignees
Milestone

Comments

@oed
Copy link
Member

oed commented Apr 20, 2020

The 3ID Account Module should be a package in the js-ceramic repo. The result of this story should be a spec for the api of this package. The module should be able to use both a ceramic-core instance and a ceramic-http-client instance to interact with ceramic.

Rough API:

  • new ThreeIDAccount (did: string, ceramic: Ceramic)
    • setDIDProvider(provider: any)
    • DID: string
    • didDocument: DIDDocument (class for interacting with 3ID doctype)
      • Should be backwards compatible. Can we use js-ipfs-did-document? (might need some changes to ceramic 3id doctype)
    • accountLinks: AccountLinks (class for interacting with account links tile)
    • sources: Sources (class for interacting with sources tile)
    • services: Services (class for interacting with services tile)
    • keychain: Keychain (class for interacting with keychain tile)
    • profile: Profile (class for interacting with profile tile)

Maybe needs an async method for constructing?

The api above describes the high level interface. For this sprint we should focus on building out the way to interact with the DID Document and AccountLinks primarily (and account tile in the background). All of the classes for the different tiles needs their own api.

Make sure to coordinate with @zachferland on the functionality that the IdentityWallet provides though the 3idProvider interface.

@oed oed added this to the Sprint 39 milestone Apr 20, 2020
@msterle msterle closed this as completed May 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants