An open API service indexing awesome lists of open source software.

https://github.com/filozone/synapse-sdk

Javascript SDK for Filecoin Onchain Cloud
https://github.com/filozone/synapse-sdk

abi blockchain contracts dapp filecoin javascript typescript web3

Last synced: 3 months ago
JSON representation

Javascript SDK for Filecoin Onchain Cloud

Awesome Lists containing this project

README

          

# ⨎ Synapse

> Javascript packages for Filecoin Onchain Cloud.

## Packages

- [@filoz/synapse-sdk](https://github.com/FilOzone/synapse-sdk/tree/master/packages/synapse-sdk) - Synapse SDK for Filecoin Onchain Cloud
- [@filoz/synapse-core](https://github.com/FilOzone/synapse-sdk/tree/master/packages/synapse-core) - JavaScript Standard Library for Filecoin Onchain Cloud
- [@filoz/synapse-react](https://github.com/FilOzone/synapse-sdk/tree/master/packages/synapse-react) - React hooks for Synapse

## Docs

Check the documentation [website](https://synapse.filecoin.services/)

[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/FilOzone/synapse-sdk)

## Examples

The `examples` folder has many examples on how to start using Synapse in different environments and frameworks.

- [`script-tag`](https://github.com/FilOzone/synapse-sdk/tree/master/examples/script-tag) - Use Synapse with CDN script tag.
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)](https://stackblitz.com/github/FilOzone/synapse-sdk/tree/master/examples/script-tag?title=Synapse%20Script%20Tag&hideExplorer=1&theme=dark)
- [`cli`](https://github.com/FilOzone/synapse-sdk/tree/master/examples/cli) - How to build a CLI in Node JS using Synapse

To clone it locally:

```bash
npx tiged FilOzone/synapse-sdk/examples/script-tag script-tag
cd script-tag
pnpm install
```

You can try any of the examples by replacing `script-tag` with the name of the example you want to try.

## Contributing

Read contributing [guidelines](.github/CONTRIBUTING.md).

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/FilOzone/synapse-sdk)

## License

Dual-licensed: [MIT](./LICENSE.md), [Apache Software License v2](./LICENSE.md) by way of the
[Permissive License Stack](https://protocol.ai/blog/announcing-the-permissive-license-stack/).