-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
31730f0
commit f0a1217
Showing
31 changed files
with
1,771 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,187 @@ | ||
| /** | ||
| * Filecoin Capabilities | ||
| * | ||
| * These can be imported directly with: | ||
| * ```js | ||
| * import * as Filecoin from '@web3-storage/capabilities/filecoin' | ||
| * ``` | ||
| * | ||
| * @module | ||
| */ | ||
|
|
||
| import { capability, Schema, ok } from '@ucanto/validator' | ||
| import { equal, equalWith, checkLink, and } from './utils.js' | ||
|
|
||
| /** | ||
| * @see https://github.com/multiformats/go-multihash/blob/dc3bd6897fcd17f6acd8d4d6ffd2cea3d4d3ebeb/multihash.go#L73 | ||
| */ | ||
| const SHA2_256_TRUNC254_PADDED = 0x1012 | ||
| /** | ||
| * @see https://github.com/ipfs/go-cid/blob/829c826f6be23320846f4b7318aee4d17bf8e094/cid.go#L104 | ||
| */ | ||
| const FilCommitmentUnsealed = 0xf101 | ||
|
|
||
| /** | ||
| * `filecoin/add` capability allows agent to add a filecoin piece to be aggregated | ||
| * so that it can be stored by a Storage provider on a future time. | ||
| */ | ||
| export const filecoinAdd = capability({ | ||
| can: 'filecoin/add', | ||
| /** | ||
| * did:key identifier of the broker authority where offer is made available. | ||
| */ | ||
| with: Schema.did(), | ||
| nb: Schema.struct({ | ||
| /** | ||
| * CID of the content that resulted in Filecoin piece. | ||
| */ | ||
| content: Schema.link(), | ||
| /** | ||
| * CID of the piece. | ||
| */ | ||
| piece: /** @type {import('./types').PieceLinkSchema} */ ( | ||
| Schema.link({ | ||
| code: FilCommitmentUnsealed, | ||
| version: 1, | ||
| multihash: { | ||
| code: SHA2_256_TRUNC254_PADDED, | ||
| }, | ||
| }) | ||
| ), | ||
| }), | ||
| derives: (claim, from) => { | ||
| return ( | ||
| and(equalWith(claim, from)) || | ||
| and(checkLink(claim.nb.content, from.nb.content, 'nb.content')) || | ||
| and(checkLink(claim.nb.piece, from.nb.piece, 'nb.piece')) || | ||
| ok({}) | ||
| ) | ||
| }, | ||
| }) | ||
|
|
||
| /** | ||
| * `piece/add` capability allows agent to add a piece piece to be aggregated | ||
| * so that it can be stored by a Storage provider on a future time. | ||
| */ | ||
| export const pieceAdd = capability({ | ||
| can: 'piece/add', | ||
| /** | ||
| * did:key identifier of the broker authority where offer is made available. | ||
| */ | ||
| with: Schema.did(), | ||
| nb: Schema.struct({ | ||
| /** | ||
| * CID of the piece. | ||
| */ | ||
| piece: /** @type {import('./types').PieceLinkSchema} */ ( | ||
| Schema.link({ | ||
| code: FilCommitmentUnsealed, | ||
| version: 1, | ||
| multihash: { | ||
| code: SHA2_256_TRUNC254_PADDED, | ||
| }, | ||
| }) | ||
| ), | ||
| /** | ||
| * CID of the content that resulted in Filecoin piece. | ||
| */ | ||
| group: Schema.text(), | ||
| }), | ||
| derives: (claim, from) => { | ||
| return ( | ||
| and(equalWith(claim, from)) || | ||
| and(checkLink(claim.nb.piece, from.nb.piece, 'nb.piece')) || | ||
| and(equal(claim.nb.group, from.nb.group, 'nb.group')) || | ||
| ok({}) | ||
| ) | ||
| }, | ||
| }) | ||
|
|
||
| /** | ||
| * `aggregate/add` capability allows agent to create an offer to get an aggregate | ||
| * of CARs files in the market to be fetched and stored by a Storage provider. | ||
| */ | ||
| export const aggregateAdd = capability({ | ||
| can: 'aggregate/add', | ||
| /** | ||
| * did:key identifier of the broker authority where offer is made available. | ||
| */ | ||
| with: Schema.did(), | ||
| nb: Schema.struct({ | ||
| /** | ||
| * CID of the DAG-CBOR encoded block with offer details. | ||
| * Service will queue given offer to be validated and handled. | ||
| */ | ||
| offer: Schema.link(), | ||
| /** | ||
| * Commitment proof for the aggregate being offered. | ||
| * https://github.com/filecoin-project/go-state-types/blob/1e6cf0d47cdda75383ef036fc2725d1cf51dbde8/abi/piece.go#L47-L50 | ||
| */ | ||
| piece: /** @type {import('./types').PieceLinkSchema} */ ( | ||
| Schema.link({ | ||
| code: FilCommitmentUnsealed, | ||
| version: 1, | ||
| multihash: { | ||
| code: SHA2_256_TRUNC254_PADDED, | ||
| }, | ||
| }) | ||
| ), | ||
| /** | ||
| * Necessary fields for a Filecoin Deal proposal. | ||
| */ | ||
| deal: Schema.struct({ | ||
| /** | ||
| * with tenantId broker can select one of their configured wallets | ||
| */ | ||
| tenantId: Schema.text(), | ||
| /** | ||
| * arbitrary label to be added to the deal on chain | ||
| */ | ||
| label: Schema.text().optional(), | ||
| }), | ||
| }), | ||
| derives: (claim, from) => { | ||
| return ( | ||
| and(equalWith(claim, from)) || | ||
| and(checkLink(claim.nb.offer, from.nb.offer, 'nb.offer')) || | ||
| and(checkLink(claim.nb.piece, from.nb.piece, 'nb.piece')) || | ||
| and( | ||
| equal(claim.nb.deal.tenantId, from.nb.deal.tenantId, 'nb.deal.tenantId') | ||
| ) || | ||
| and(equal(claim.nb.deal.label, from.nb.deal.label, 'nb.deal.label')) || | ||
| ok({}) | ||
| ) | ||
| }, | ||
| }) | ||
|
|
||
| /** | ||
| * `chain/info` capability allows agent to get chain info of a given piece. | ||
| */ | ||
| export const chainInfo = capability({ | ||
| can: 'chain/info', | ||
| /** | ||
| * did:key identifier of the broker authority where offer is made available. | ||
| */ | ||
| with: Schema.did(), | ||
| nb: Schema.struct({ | ||
| /** | ||
| * CID of the piece. | ||
| */ | ||
| piece: /** @type {import('./types').PieceLinkSchema} */ ( | ||
| Schema.link({ | ||
| code: FilCommitmentUnsealed, | ||
| version: 1, | ||
| multihash: { | ||
| code: SHA2_256_TRUNC254_PADDED, | ||
| }, | ||
| }) | ||
| ), | ||
| }), | ||
| derives: (claim, from) => { | ||
| return ( | ||
| and(equalWith(claim, from)) || | ||
| and(checkLink(claim.nb.piece, from.nb.piece, 'nb.piece')) || | ||
| ok({}) | ||
| ) | ||
| }, | ||
| }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.