Ecclesia NPM | npm.io

API for interacting with Kwil (formerly Ecclesia)

Installation

npm i ecclesia

Initialization

Currently this library auto-initializes to a URL. This will change in the near future.

const kwil = require('ecclesia')

//OR

import kwil from 'ecclesia'

Creating an account

The createAccount method has 2 optional inputs. If for some reason you want to set your own salt, the third input can be used to set a salt. Salts should be 16 characters in length, however they can be shorter if you wanted to for some reason. The fourth optional input is for adding an email. Currently there is no advantage of including an email in registration, however this is left here to allow for IMAP tooling to be built for Kwil in the future.

Creating an Account

if (!await kwil.ifUserExists('brennanjl)) {
   const keys = await kwil.createAccount('brennanjl', 'Password123')
   console.log(keys.privateKey)
}

If you wish to retrieve your Kwil key, you can use the login method.

Logging in to an Account

const key = await kwil.login('brennanjl', 'Password123')
console.log(key.privateKey)

Changing Account Data

There are several methods to alter account data. The recommended method is using changeAllAccountData(new_display_name, new_bio, new_pfp, new_banner, privateKey, username). If you wish to not alter one of these, pass the parameter an empty string. If you wish to remove an attribute, pass it null. Feed in images as base64. Make sure that you only send the image's base64. Many conversion methods keep a 16 character prefix.

Changing Profile Data

await kwil.changeAllAccountData('Brennan Lamey', 'Founder of Kwil!', myBase64PFP, '', privateKey, 'brennanjl')

There are also methods for changeNameAndBio, changePFP, and changeBanner, but it is not recommended to use these as they are no longer maintained.

There are several methods for getting account data, but it is only recommended to use getAccountData and getAllAccountData. These functions are the same, except getAccountData returns the profile picture and banner as URLs instead of hashes.

Getting Account Data

await kwil.getAccountData('brennanjl')

const accountData = await kwil.getAllAccountData('brennanjl')
const pfpURL = kwil.getPhotoURL(accountData.photoHash)
const bannerURL = kwil.getPhotoURL(accountData.bannerHash)

Following

await kwil.follow('brennanjl', 'satoshi', privateKey)
await kwil.unfollow('brennanjl', 'satoshi', privateKey)
await kwil.isFollowing('brennanjl', 'satoshi')

Getting Follow Data

const followers = await kwil.getFollowers('brennanjl')
const following = await kwil.getFollowing('brennanjl')

Groups

Groups functionality is one of the most powerful aspects of the Kwil protocol. In this section, I will cover how to utilize groups functionality. In the future, I would like to paste a link to a section of a whitepaper / informational site explaining the technicalities behind groups.

To create a group, user the createGroup method: createGroup(group_name, publicity, group_description, group_tags, group_image, group_banner, links, color, your_username, your_private_jwk). If you wish to leave image or banner blank, pass an empty string. To leave links and tags blank, use an empty array.

Creating a Group

if (!await kwil.ifGroupExists('arweavers')){
  await kwil.createGroup('arweavers', true, 'Arweavers community!', ['blockchain', 'technology'], groupImage, groupBanner, [], '#65b110', 'brennanjl', privateKey)
}

Editing a Group

The editGroup method uses the same params as the createGroup method. For any inputs that you don't want to change, you should pass an empty string (Even if for the links and tags parameters, you should pass an empty string). Any group moderator can edit a group.

await kwil.editGroup('arweavers', false, '', '', newGroupImage, '', ['https://kwil.com'], '', 'brennanjl', privateKey)

Getting Group Data

Group data can be retrieved with the getGroupData method. Parameters: getGroupData(group_name). Group posts can be retrieved with the getGroupPosts method. Parameters: getGroupPosts(group_name, date_cursor, query_limit). date_cursor and query_limit are optional.

const groupData = await kwil.getGroupData('arweavers')
const groupPosts = await kwil.getGroupPosts('arweavers', new Date, 20)

Group data can also be retrieved with the getGroupPreview method. This method returns the group data, as well as the most recent post for the group.

await kwil.getGroupPreview('arweavers')

Group Followers

You can follow and unfollow groups using the followGroup and unfollowGroup methods. Parameters for both: followGroup/unfollowGroup(group_name, your_username, your_private_jwk)

await kwil.followGroup('arweavers', 'brennanjl', privateKey)

Group followers can be found using the getGroupFollowers method. You can also check if someone follows a specific group using the isFollowingGroup method.

const followers = await kwil.getGroupFollowers('arweavers')
const isFollowing = await kwil.isFollowingGroup('brennanjl', 'arweavers')

You can also find what groups a user is following using the getGroups method.

const groups = await kwil.getGroups('brennanjl')

Adding Moderators

Group moderators can control all aspects of a group that an owner can. The only difference is that a moderator can not remove a group owner. The group owner, and other moderators, can remove a moderator. Parameters: addMember/removeMember(group_name, user_to_add/remove, your_username, your_private_key)

if (!await kwil.isMember('satoshi') {
   await kwil.addMember('arweavers', 'satoshi', 'brennanjl', privateKey)
}

//or

if (await kwil.isMember('satoshi') {
   await kwil.removeMember('arweavers', 'satoshi', 'brennanjl', privateKey)
}

A list of moderators can be retrieved using the getMembers method.

const members = await kwil.getMembers('arweavers')

Posting

The Kwil protocol supports three types of posts: thoughts, thinkpieces, and comments. Thoughts are short-form pieces of content. They can have a max of 300 characters, as well as a photo. Thinkpieces are long-form pieces of content. They can have a maximum of 12,000 characters (roughly four pages typed), and can have up to five photos associated with them. Lastly, comments are maximum 300 characters that can not have an image associated. They can be used to reference any thought, thinkpiece, or comment. Parameters: createThought(post_text, post_image, private_key, username, group_name (optional)). createThinkpiece(title, post_text, myImage1, myImage2, private_key, username, groupTag (optional)). comment(post_text, referencing_post_id, private_key, username, reference_type(post/comment)). The last paramter of comment (reference_type) should be either post or comment.

Creating a Post

await createThought('My first thought!', myImage, privateKey, 'brennanjl', 'arweavers')
await createThinkpiece('My Thinkpiece', 'Lorem ipsum...', [img1, img2], privateKey, 'brennanjl', 'arweavers')

await comment('Nice post!', referenceID, privateKey, 'brennanjl', 'post')
// OR

await comment('Nice post!', referenceID, privateKey, 'brennanjl', 'comment')

Getting Posts

To get posts, use the getPosts, getThoughts, getThinkpieces, getComments, getPostByID, getFeed, getFeedUsersOnly, and getFeedGroupsOnly methods. Parameters:

getPosts(username, date_cursor (optional), query_limit (optional))
getThoughts(username, date_cursor (optional), query_limit (optional))
getThinkpieces(username, date_cursor (optional), query_limt(optional))
getComments(post_ID, post_type (either 'post' or 'comment'), date_cursor (optional), query_limit(optional))
getPostByID(post_ID)
getFeed(username, date_cursor (optional), query_limit (optional))
getFeedUsersOnly(username, date_cursor (optional), query_limit (optional))
getFeedGroupsOnly(username, date_cursor (optional), query_limit (optional))

const posts = await kwil.getPosts('brennanjl', new Date, 20)
const thoughts = await kwil.getThoughts('brennanjl', new Date, 20)
const thinkpieces = await kwil.getThinkpieces('brennanjl', new Date, 20)
const comments = await kwil.getComments(postID, 'post', new Date, 20)

Likes

Kwil allows users to like and dislike thoughts, thinkpieces, and comments. The like() method is as follows: like(type, post_ID, your_username, your_private_jwk). The "type" parameter should be true or false, where true is a like and false is a dislike. If you have previous liked a post and then dislike (or vice versa), it will automatically overwrite your previous entry. To remove a like or dislike, use the unlike() method: unlike(post_ID, your_username, your_private_jwk).

Liking

await kwil.like(true, 'abc123', 'brennanjl', privateKey)
await kwil.unlike('abc123', 'brennanjl', privateKey)

Post Stats

You can get a posts stats using the getPostStats() method: getPostStats(post_ID, username (optional)). If you pass a username, it will return if you have liked the post or not.