Interface Service

Hierarchy

Properties

filecoin store upload usage

Properties

filecoin

filecoin: {
    accept: ServiceMethod<{
        can: "filecoin/accept";
        nb: Pick<{
            content: Link<unknown, number, number, 0 | 1>;
            piece: PieceLink;
        }, RequiredKeys<{
            content: Link<unknown, number, number, 0 | 1>;
            piece: PieceLink;
        }>> & Partial<Pick<{
            content: Link<unknown, number, number, 0 | 1>;
            piece: PieceLink;
        }, never>>;
        with: `did:${string}:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, "/home/runner/work/w3up/w3up/packages/access-client/dist/src/types".FilecoinAcceptSuccess, "/home/runner/work/w3up/w3up/packages/access-client/dist/src/types".FilecoinAcceptFailure>;
    info: ServiceMethod<{
        can: "filecoin/info";
        nb: Pick<{
            piece: PieceLink;
        }, "piece"> & Partial<Pick<{
            piece: PieceLink;
        }, never>>;
        with: `did:${string}:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, FilecoinInfoSuccess, FilecoinInfoFailure>;
    offer: ServiceMethod<{
        can: "filecoin/offer";
        nb: Pick<{
            content: Link<unknown, number, number, 0 | 1>;
            piece: PieceLink;
        }, RequiredKeys<{
            content: Link<unknown, number, number, 0 | 1>;
            piece: PieceLink;
        }>> & Partial<Pick<{
            content: Link<unknown, number, number, 0 | 1>;
            piece: PieceLink;
        }, never>>;
        with: `did:${string}:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, FilecoinOfferSuccess, FilecoinOfferFailure>;
    submit: ServiceMethod<{
        can: "filecoin/submit";
        nb: Pick<{
            content: Link<unknown, number, number, 0 | 1>;
            piece: PieceLink;
        }, RequiredKeys<{
            content: Link<unknown, number, number, 0 | 1>;
            piece: PieceLink;
        }>> & Partial<Pick<{
            content: Link<unknown, number, number, 0 | 1>;
            piece: PieceLink;
        }, never>>;
        with: `did:${string}:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, "/home/runner/work/w3up/w3up/packages/access-client/dist/src/types".FilecoinSubmitSuccess, "/home/runner/work/w3up/w3up/packages/access-client/dist/src/types".FilecoinSubmitFailure>;
}

Type declaration

store

store: {
    add: ServiceMethod<{
        can: "store/add";
        nb: Pick<{
            link: Link<unknown, 514, number, 1>;
            origin: undefined | Link<unknown, number, number, 0 | 1>;
            size: number & Phantom<{
                typeof: "integer";
            }>;
        }, RequiredKeys<{
            link: Link<unknown, 514, number, 1>;
            origin: undefined | Link<unknown, number, number, 0 | 1>;
            size: number & Phantom<{
                typeof: "integer";
            }>;
        }>> & Partial<Pick<{
            link: Link<unknown, 514, number, 1>;
            origin: undefined | Link<unknown, number, number, 0 | 1>;
            size: number & Phantom<{
                typeof: "integer";
            }>;
        }, "origin">>;
        with: `did:key:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, "/home/runner/work/w3up/w3up/packages/access-client/dist/src/types".StoreAddSuccess, Failure>;
    get: ServiceMethod<{
        can: "store/get";
        nb: Pick<{
            link: undefined | Link<unknown, 514, number, 1>;
        }, never> & Partial<Pick<{
            link: undefined | Link<unknown, 514, number, 1>;
        }, "link">>;
        with: `did:key:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, StoreListItem, "/home/runner/work/w3up/w3up/packages/access-client/dist/src/types".StoreGetFailure>;
    list: ServiceMethod<{
        can: "store/list";
        nb: Pick<{
            cursor: undefined | string;
            pre: undefined | boolean;
            size: undefined | number & Phantom<{
                typeof: "integer";
            }>;
        }, never> & Partial<Pick<{
            cursor: undefined | string;
            pre: undefined | boolean;
            size: undefined | number & Phantom<{
                typeof: "integer";
            }>;
        }, OptionalKeys<{
            cursor: undefined | string;
            pre: undefined | boolean;
            size: undefined | number & Phantom<{
                typeof: "integer";
            }>;
        }>>>;
        with: `did:key:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, StoreListSuccess, Failure>;
    remove: ServiceMethod<{
        can: "store/remove";
        nb: Pick<{
            link: Link<unknown, 514, number, 1>;
        }, "link"> & Partial<Pick<{
            link: Link<unknown, 514, number, 1>;
        }, never>>;
        with: `did:key:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, StoreRemoveSuccess, "/home/runner/work/w3up/w3up/packages/access-client/dist/src/types".StoreRemoveFailure>;
}

Type declaration

  • add: ServiceMethod<{
        can: "store/add";
        nb: Pick<{
            link: Link<unknown, 514, number, 1>;
            origin: undefined | Link<unknown, number, number, 0 | 1>;
            size: number & Phantom<{
                typeof: "integer";
            }>;
        }, RequiredKeys<{
            link: Link<unknown, 514, number, 1>;
            origin: undefined | Link<unknown, number, number, 0 | 1>;
            size: number & Phantom<{
                typeof: "integer";
            }>;
        }>> & Partial<Pick<{
            link: Link<unknown, 514, number, 1>;
            origin: undefined | Link<unknown, number, number, 0 | 1>;
            size: number & Phantom<{
                typeof: "integer";
            }>;
        }, "origin">>;
        with: `did:key:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, "/home/runner/work/w3up/w3up/packages/access-client/dist/src/types".StoreAddSuccess, Failure>
  • get: ServiceMethod<{
        can: "store/get";
        nb: Pick<{
            link: undefined | Link<unknown, 514, number, 1>;
        }, never> & Partial<Pick<{
            link: undefined | Link<unknown, 514, number, 1>;
        }, "link">>;
        with: `did:key:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, StoreListItem, "/home/runner/work/w3up/w3up/packages/access-client/dist/src/types".StoreGetFailure>
  • list: ServiceMethod<{
        can: "store/list";
        nb: Pick<{
            cursor: undefined | string;
            pre: undefined | boolean;
            size: undefined | number & Phantom<{
                typeof: "integer";
            }>;
        }, never> & Partial<Pick<{
            cursor: undefined | string;
            pre: undefined | boolean;
            size: undefined | number & Phantom<{
                typeof: "integer";
            }>;
        }, OptionalKeys<{
            cursor: undefined | string;
            pre: undefined | boolean;
            size: undefined | number & Phantom<{
                typeof: "integer";
            }>;
        }>>>;
        with: `did:key:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, StoreListSuccess, Failure>
  • remove: ServiceMethod<{
        can: "store/remove";
        nb: Pick<{
            link: Link<unknown, 514, number, 1>;
        }, "link"> & Partial<Pick<{
            link: Link<unknown, 514, number, 1>;
        }, never>>;
        with: `did:key:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, StoreRemoveSuccess, "/home/runner/work/w3up/w3up/packages/access-client/dist/src/types".StoreRemoveFailure>

upload

upload: {
    add: ServiceMethod<{
        can: "upload/add";
        nb: Pick<{
            root: Link<unknown, number, number, 0 | 1>;
            shards: undefined | Link<unknown, MulticodecCode<514, "CAR">, number, 1>[];
        }, "root"> & Partial<Pick<{
            root: Link<unknown, number, number, 0 | 1>;
            shards: undefined | Link<unknown, MulticodecCode<514, "CAR">, number, 1>[];
        }, "shards">>;
        with: `did:key:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, UploadAddSuccess, Failure>;
    get: ServiceMethod<{
        can: "upload/get";
        nb: Pick<{
            root: undefined | Link<unknown, number, number, 0 | 1>;
        }, never> & Partial<Pick<{
            root: undefined | Link<unknown, number, number, 0 | 1>;
        }, "root">>;
        with: `did:key:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, UploadListItem, "/home/runner/work/w3up/w3up/packages/access-client/dist/src/types".UploadGetFailure>;
    list: ServiceMethod<{
        can: "upload/list";
        nb: Pick<{
            cursor: undefined | string;
            pre: undefined | boolean;
            size: undefined | number & Phantom<{
                typeof: "integer";
            }>;
        }, never> & Partial<Pick<{
            cursor: undefined | string;
            pre: undefined | boolean;
            size: undefined | number & Phantom<{
                typeof: "integer";
            }>;
        }, OptionalKeys<{
            cursor: undefined | string;
            pre: undefined | boolean;
            size: undefined | number & Phantom<{
                typeof: "integer";
            }>;
        }>>>;
        with: `did:key:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, UploadListSuccess, Failure>;
    remove: ServiceMethod<{
        can: "upload/remove";
        nb: Pick<{
            root: Link<unknown, number, number, 0 | 1>;
        }, "root"> & Partial<Pick<{
            root: Link<unknown, number, number, 0 | 1>;
        }, never>>;
        with: `did:key:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, UploadAddSuccess, Failure>;
}

Type declaration

  • add: ServiceMethod<{
        can: "upload/add";
        nb: Pick<{
            root: Link<unknown, number, number, 0 | 1>;
            shards: undefined | Link<unknown, MulticodecCode<514, "CAR">, number, 1>[];
        }, "root"> & Partial<Pick<{
            root: Link<unknown, number, number, 0 | 1>;
            shards: undefined | Link<unknown, MulticodecCode<514, "CAR">, number, 1>[];
        }, "shards">>;
        with: `did:key:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, UploadAddSuccess, Failure>
  • get: ServiceMethod<{
        can: "upload/get";
        nb: Pick<{
            root: undefined | Link<unknown, number, number, 0 | 1>;
        }, never> & Partial<Pick<{
            root: undefined | Link<unknown, number, number, 0 | 1>;
        }, "root">>;
        with: `did:key:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, UploadListItem, "/home/runner/work/w3up/w3up/packages/access-client/dist/src/types".UploadGetFailure>
  • list: ServiceMethod<{
        can: "upload/list";
        nb: Pick<{
            cursor: undefined | string;
            pre: undefined | boolean;
            size: undefined | number & Phantom<{
                typeof: "integer";
            }>;
        }, never> & Partial<Pick<{
            cursor: undefined | string;
            pre: undefined | boolean;
            size: undefined | number & Phantom<{
                typeof: "integer";
            }>;
        }, OptionalKeys<{
            cursor: undefined | string;
            pre: undefined | boolean;
            size: undefined | number & Phantom<{
                typeof: "integer";
            }>;
        }>>>;
        with: `did:key:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, UploadListSuccess, Failure>
  • remove: ServiceMethod<{
        can: "upload/remove";
        nb: Pick<{
            root: Link<unknown, number, number, 0 | 1>;
        }, "root"> & Partial<Pick<{
            root: Link<unknown, number, number, 0 | 1>;
        }, never>>;
        with: `did:key:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, UploadAddSuccess, Failure>

usage

usage: {
    report: ServiceMethod<{
        can: "usage/report";
        nb: Pick<{
            period: InferStruct<{
                from: NumberSchema<number & Phantom<{
                    typeof: "integer";
                }>, unknown>;
                to: NumberSchema<number & Phantom<{
                    typeof: "integer";
                }>, unknown>;
            }>;
        }, "period"> & Partial<Pick<{
            period: InferStruct<{
                from: NumberSchema<number & Phantom<{
                    typeof: "integer";
                }>, unknown>;
                to: NumberSchema<number & Phantom<{
                    typeof: "integer";
                }>, unknown>;
            }>;
        }, never>>;
        with: `did:key:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, UsageReportSuccess, Failure>;
}

Type declaration

  • report: ServiceMethod<{
        can: "usage/report";
        nb: Pick<{
            period: InferStruct<{
                from: NumberSchema<number & Phantom<{
                    typeof: "integer";
                }>, unknown>;
                to: NumberSchema<number & Phantom<{
                    typeof: "integer";
                }>, unknown>;
            }>;
        }, "period"> & Partial<Pick<{
            period: InferStruct<{
                from: NumberSchema<number & Phantom<{
                    typeof: "integer";
                }>, unknown>;
                to: NumberSchema<number & Phantom<{
                    typeof: "integer";
                }>, unknown>;
            }>;
        }, never>>;
        with: `did:key:${string}` & `did:${string}` & Phantom<{
            protocol: "did:";
        }> & `${string}:${string}`;
    }, UsageReportSuccess, Failure>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc