@safient/core

Safient Core SDK

JavaScript SDK to manage and interact with the safes on Safient protocol.

Trustless crypto asset safe and inheritance protocol

Getting started

  npm i @safient/core

Local installation

  git clone https://github.com/safient/safient-core.git
  cd safient-core
  npm install
  npm run build

Running Tests

Create an .env file in the middleware and root folder with USER_API_KEY, USER_API_SECRET and DB_FILE_NAME='./thread.config'

  cd ..
  npm run test

Building docs

Update the docs markdown

npm run build:docs

Run the docusaurus website locally

npm run serve:docs

Technologies used:

• Ceramic IDX
• Textile ThreadDb

Contributing

You are welcome to submit issues and enhancement requests and work on any of the existing issues. Follow this simple guide to contribute to the repository.

1. Create or pick an existing issue to work on
2. Fork the repo on GitHub
3. Clone the forked project to your own machine
4. Commit changes to your own branch
5. Push your work back up to your forked repo
6. Submit a Pull request from the forked repo to our repo so that we can review your changes

Resources:

• Website
• Web App
• Twitter
• Discord