orbisweb3 / orbis-sdk Goto Github PK

Official repository for the Orbis SDK.

JavaScript 100.00%

orbis-sdk's Introduction

Build decentralized social apps with the Orbis SDK

By using the Orbis SDK, developers can build their own decentralized social apps or add a decentralized social features to their existing application in a very easy and performant way.

Why you should build on Orbis

By being built on top of Ceramic, Orbis offers many advantages to developers interested in building decentralized social applications:

No transaction fees
Users don’t have to sign a message for each action they take
Write times are very fast which offers a user experience similar to web2
Every piece of content shared on Orbis is decentralized on the Ceramic network and anyone can access it
There is a full composability between apps built on the Orbis ecosystem
(Coming soon) Multichain: Users can join Orbis using additional chains such as Cosmos or Solana and interact together in the same digital space

Use cases

Here are some examples of applications that could be built on top of Orbis:

Full social apps like orbis.club
Decentralized & encrypted messaging system
Fully customizable & embedded group chat servers
Decentralized Discourse governance forums
Decentralized support system (similar to Intercom)
Decentralized version of Slack
Decentralized commenting features
And many other things...

Documentation

Our documentation is available at https://useorbis.com/documentation

orbis-sdk's People

Contributors

Stargazers

Watchers

orbis-sdk's Issues

Idea: Many-to-many relationship between Project and Context

Idea

Currently the Project object and the Context object have a one-to-many relationship. Project can have many contexts, while context only belongs to one project.

Context:

{
  "name": "SGB Chat",
  "project_id": "kjzl6cwe1jw145qvssudltw3f1qxhehs4yulyntvgzbs1jeco1yy3vv7kfm5uka",
  "websiteUrl": "https://sgb.chat",
  "accessRules": [],
  "displayName": "SGB Chat",
  "integrations": {
    "discord": {
      "channel_id": "1083760838004973678"
    }
  }
}

Project:

{
  "name": "Sgb.chat",
  "website": "sgb.chat"
}

I propose switching to the many-to-many relationship between the two. This would mean that a context can be used by many projects.

Reasoning behind this idea

Let's say there's a community that has an Orbis chat frontend operated by person A. This person has very strict rules on which content to allow in the chat and regularly removes posts that do not fit these rules. Because part of the community does not agree with so strict censorship rules, a person B sets up an alternative frontend, but using the same context.

If we want person B to be able to run their own frontend with the same context, but having their own censorship rules, the many-to-many relationship between Project and Context is needed. Post removals need to occur on the Project level. Some posts can be removed in one project, but remain visible in another, even though both use the same Context.

Changes required

@baptistegreve I would love to hear your opinion on this and what kind of changes would it require. Could it be developed in a backwards compatible way? Or having both systems running in parallel? Let me know your thoughts 🙂

Other provider support

I tried to use ceramic's key-did-provider-ed25519

but seem to get this error:

provider.enable is not a function

code:

async connectOrbis(seed:string) {


    const enc = new TextEncoder();
    const authSecret = enc.encode(seed);

    const provider = new Ed25519Provider(authSecret)

    let res = await this.orbis.connect(provider);
    console.log('orbit connect', res);
  }

Thanks

Profanity filter (discussion)

I wanted to post this "prophecy cat" gif link in one of my Orbis posts:

https://tenor.com/en-GB/view/dafuq-cat-flower-head-the-prophecy-is-true-gif-16939346

But the post just wouldn't go through. I was banging my head against a (virtual) wall for like 10 minutes until I realized that the post does not go through because there's a word "dafuq" in the GIF URL 😅

A profanity filter is an interesting topic to discuss. Here's a few questions:

Should profanity be filtered at a protocol level or not?
If yes, should it be filtered by default?
Should devs have an option in the SDK to turn the profanity filter on or off? (in getPosts() options)

Would love to hear your opinion on that @baptistegreve 🙂

context update should not require name

When trying to update a context access rules if you do not supply the name field the update request will fail.

Docs Broken Links and Images

404
https://useorbis.com/dashboard

limit as parameter in getPosts()

Currently the getPosts() function in the SDK has a hardcoded post limit at 50.

It would be great if limit was a parameter so that developers could choose a different size limit:

async getPosts(options, page = 0, limit = 50) {

If that only requires changes in this function (and no backend changes), I can do that and push it as PR, to save you some time. Please let me know @baptistegreve 🙂

RSS for useorbis.com/blog

Please add RSS for your blog at https://useorbis.com/blog

Module not found: Default condition should be last one

error - ./node_modules/@ceramicnetwork/streamid/lib/commit-id.js:27:0
Module not found: Default condition should be last one

Import trace for requested module:
./node_modules/@ceramicnetwork/streamid/lib/index.js
./node_modules/@ceramicnetwork/http-client/lib/ceramic-http-client.js
./node_modules/@orbisclub/orbis-sdk/index.js
./src/components/layout/index.tsx
./src/pages/_app.tsx

https://nextjs.org/docs/messages/module-not-found
wait - compiling /_error (client and server)...
error - ./node_modules/@ceramicnetwork/streamid/lib/commit-id.js:27:0
Module not found: Default condition should be last one

https://nextjs.org/docs/messages/module-not-found