sgtpooki/Filecoin Pin Upload
Pack site into a CAR, upload via filecoin-pin to Filecoin, and publish build artifacts.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| path | Path to content to upload (file or directory). Typically your build output directory. | yes | — |
| walletPrivateKey | Wallet private key used to fund uploads (USDFC on Calibration/Mainnet). | yes | — |
| network | What Filecoin network to use. Should either be "mainnet" or "calibration". | yes | — |
| minStorageDays | Minimum runway in days of funding to keep the current data set persisted on Filecoin. This number is used to calculate the minimum Filecoin Pay balance to meet this runway. This calculation assumes that all of the Filecoin Pay balance will go towards storage for this data set, which won't be true for wallets that have multiple data sets or are using Filecoin Pay with other Filecoin Onchain Cloud services. If this isn't specified, this action will not make any Filecoin Pay deposits. If the current Filecoin Pay balance is already above this target, then no token deposits are attempted from the wallet. If the current Filecoin Pay balance is below this target, the necessary deposit will be attempted if through the `filecoinPayBalanceLimit` (see below). If there are insufficient funds in the wallet, the action will fail. SECURITY: Hardcode this in trusted workflows. | no | — |
| filecoinPayBalanceLimit | Specifies a target Filecoin Pin balance in USDFC that this action will never exceed. Actions (manual or other) outside of this action may cause the Filecoin Pay balance to exceed this limit, but this limit prevents the action from using thewallet to top up the Filecoin Pay balance beyond the limit. As a protection, this must be set if `minStorageDays` is set. SECURITY: Hardcode this in trusted workflows. | no | — |
| providerAddress | Optional override for storage provider address (on Calibration/Mainnet). Defaults to a known good provider on Calibration. | no | 0xa3971A7234a3379A1813d9867B531e7EeB20ae07 |
| withCDN | If true, request CDN in the storage context (depends on provider capabilities). Warning: filecoin-pin does not calculate deposits and run-rate costs properly with CDN enabled. | no | false |
| dryRun | If true, run in dry-run mode - build CAR file and validate inputs but skip actual upload to Filecoin. Useful for testing and validation. | no | false |
Outputs
| name | description |
|---|---|
| ipfsRootCid | IPFS Root CID |
| dataSetId | Synapse Data Set ID |
| pieceCid | Filecoin Piece CID |
| providerId | Storage Provider ID |
| providerName | Storage Provider Name |
| carPath | Path to the created CAR file |
| uploadStatus | Upload status (uploaded, reused-cache, reused-artifact) |