| description | What is the Synapse SDK? | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| layout |
|
The Synapse SDK is an easy-to-use library allowing developers to get started with the Filecoin Onchain Cloud and its services, such as Filecoin Beam. It allows you to store & retrieve data from Filecoin, as well as pay for these services.
When making storage deals, you can set up your data to retrievable through Filecoin Beam by setting the withCDN flag to true in the Synapse SDK config.
const synapse = await Synapse.create({
privateKey: "YOUR_PRIVATE_KEY",
withCDN: true,
});Head to the Synapse getting started guide to get started, and to see clearly in code how to include Filecoin Beam when you create an instance of Synapse.
- Learn more about Synapse SDK in their documentation on GitHub.
- See Synapse end-to-end example for a CLI tool for uploading files to the Filecoin Warm Storage Service.
- See Synapse post-deploy setup for a CLI tool setting up Filecoin Pay deposit & allowances.