Skip to content

Commit ba725fe

Browse files
committed
chore: update docs
1 parent b6bee65 commit ba725fe

File tree

2 files changed

+33
-5
lines changed

2 files changed

+33
-5
lines changed

packages/config-bundles/sys/README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,19 @@ export const ipfsProviders: string[] = [
1818
"https://ipfs.io",
1919
];
2020

21-
export const bundle: Bundle = {
21+
export interface SysCommonBundle extends Bundle {
22+
logger: BundlePackage;
23+
datetime: BundlePackage;
24+
concurrent: BundlePackage;
25+
http: BundlePackage;
26+
githubResolver: BundlePackage;
27+
httpResolver: BundlePackage;
28+
wrapscanResolver: BundlePackage;
29+
ipfsHttpClient: BundlePackage;
30+
ipfsResolver: BundlePackage;
31+
}
32+
33+
export const bundle: SysCommonBundle = {
2234
logger: {
2335
uri: "plugin/logger@1.0.0",
2436
package: loggerPlugin({}) as IWrapPackage,
@@ -94,7 +106,12 @@ If you're using this package within Node.JS, you'll also have the following conf
94106
import { fileSystemPlugin } from "@polywrap/file-system-plugin-js";
95107
import * as fileSystemResolver from "./embeds/file-system-resolver/wrap";
96108

97-
export const bundle: Bundle = {
109+
interface SysNodeBundle extends Common.SysCommonBundle {
110+
fileSystem: BundlePackage;
111+
fileSystemResolver: BundlePackage;
112+
}
113+
114+
export const bundle: SysNodeBundle = {
98115
...Common.bundle,
99116
fileSystem: {
100117
uri: "plugin/file-system@1.0",

packages/config-bundles/web3/README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,18 @@ A collection of Web3 configurations.
88
import * as Sys from "@polywrap/sys-config-bundle-js";
99
import * as EthWallet from "@polywrap/ethereum-wallet-js";
1010

11-
export const bundle: Bundle = {
11+
export interface Web3Bundle extends Bundle {
12+
concurrent: BundlePackage;
13+
http: BundlePackage;
14+
ipfsHttpClient: BundlePackage;
15+
ipfsResolver: BundlePackage;
16+
ethereumWallet: BundlePackage;
17+
ensTextRecordResolver: BundlePackage;
18+
ensContenthashResolver: BundlePackage;
19+
ensIpfsContenthashResolver: BundlePackage;
20+
}
21+
22+
export const bundle: Web3Bundle = {
1223
concurrent: Sys.bundle.concurrent,
1324
http: Sys.bundle.http,
1425
ipfsHttpClient: Sys.bundle.ipfsHttpClient,
@@ -40,8 +51,8 @@ export const bundle: Bundle = {
4051
],
4152
redirectFrom: ["wrapscan.io/polywrap/ens-text-record-uri-resolver@1.0"],
4253
},
43-
ensResolver: {
44-
uri: "wrapscan.io/polywrap/ens-uri-resolver@1.0",
54+
ensContenthashResolver: {
55+
uri: "wrapscan.io/polywrap/ens-contenthash-uri-resolver@1.0",
4556
implements: [ExtendableUriResolver.defaultExtInterfaceUris[0].uri],
4657
},
4758
ensIpfsContenthashResolver: {

0 commit comments

Comments
 (0)