Class BasicRootTree

The tree that ties different file systems together.

Implements

RootTree

Constructors

constructor

new BasicRootTree(__namedParameters): BasicRootTree
Parameters
- __namedParameters: {
      blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
      did: undefined | string;
      exchangeRoot: PublicDirectory;
      privateForest: PrivateForest;
      publicRoot: PublicDirectory;
      shareCounter: number;
      unix: PBNode;
      version: string;
  }
  - blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>
  - did: undefined | string
  - exchangeRoot: PublicDirectory
  - privateForest: PrivateForest
  - publicRoot: PublicDirectory
  - shareCounter: number
  - unix: PBNode
  - version: string
Returns BasicRootTree
- Defined in packages/nest/src/root-tree/basic.ts:37

Methods

clone

clone(): RootTree
Returns RootTree
Implementation of RootTree.clone
- Defined in packages/nest/src/root-tree/basic.ts:334

did

did(): undefined | string
Returns undefined | string
Implementation of RootTree.did
- Defined in packages/nest/src/root-tree/basic.ts:188

replaceDID

replaceDID(did): Promise<RootTree>
Parameters
- did: string
Returns Promise<RootTree>
Implementation of RootTree.replaceDID
- Defined in packages/nest/src/root-tree/basic.ts:192

replaceExchangeRoot

replaceExchangeRoot(dir): Promise<RootTree>
Parameters
- dir: PublicDirectory
Returns Promise<RootTree>
Implementation of RootTree.replaceExchangeRoot
- Defined in packages/nest/src/root-tree/basic.ts:210

replacePrivateForest

replacePrivateForest(forest, _modifications): Promise<RootTree>
Parameters
- forest: PrivateForest
- _modifications: Modification[]
Returns Promise<RootTree>
Implementation of RootTree.replacePrivateForest
- Defined in packages/nest/src/root-tree/basic.ts:228

replacePublicRoot

replacePublicRoot(dir, modifications): Promise<RootTree>
Parameters
- dir: PublicDirectory
- modifications: Modification[]
Returns Promise<RootTree>
Implementation of RootTree.replacePublicRoot
- Defined in packages/nest/src/root-tree/basic.ts:249

shareCounter

shareCounter(): number
Returns number
Implementation of RootTree.shareCounter
- Defined in packages/nest/src/root-tree/basic.ts:316

store

store(): Promise<CID<unknown, number, number, Version>>
Returns Promise<CID<unknown, number, number, Version>>
Implementation of RootTree.store
- Defined in packages/nest/src/root-tree/basic.ts:348

`Static` create

create(blockstore): Promise<BasicRootTree>
Create a new root tree.
Parameters
- blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>
Returns Promise<BasicRootTree>
- Defined in packages/nest/src/root-tree/basic.ts:71

`Static` fromCID

fromCID(blockstore, cid): Promise<BasicRootTree>
Load an existing root tree.
Parameters
- blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>
- cid: CID<unknown, number, number, Version>
Returns Promise<BasicRootTree>
- Defined in packages/nest/src/root-tree/basic.ts:93

Properties

`Private` `Readonly` #blockstore

#blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

Type declaration

`Private` `Readonly` #did

#did: undefined | string

`Private` `Readonly` #exchangeRoot

#exchangeRoot: PublicDirectory

`Private` `Readonly` #privateForest

#privateForest: PrivateForest

`Private` `Readonly` #publicRoot

#publicRoot: PublicDirectory

`Private` `Readonly` #shareCounter

#shareCounter: number

`Private` `Readonly` #unix

#unix: PBNode

`Private` `Readonly` #version

#version: string

Class BasicRootTree

Implements

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

blockstore: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>

did: undefined | string

exchangeRoot: PublicDirectory

privateForest: PrivateForest

publicRoot: PublicDirectory

shareCounter: number

unix: PBNode

version: string

Returns BasicRootTree

Methods

clone

Returns RootTree

did

Returns undefined | string

exchangeRoot

Returns PublicDirectory

increaseShareCounter

Returns Promise<RootTree>

privateForest

Returns PrivateForest

publicRoot

Returns PublicDirectory

replaceDID

Parameters

Returns Promise<RootTree>

replaceExchangeRoot

Parameters

Returns Promise<RootTree>

replacePrivateForest

Parameters

Returns Promise<RootTree>

replacePublicRoot

Parameters

Returns Promise<RootTree>

shareCounter

Returns number

store

Returns Promise<CID<unknown, number, number, Version>>

Static create

Parameters

Returns Promise<BasicRootTree>

Static fromCID

Parameters

Returns Promise<BasicRootTree>

Properties

Private Readonly #blockstore

Type declaration

Type declaration

Type declaration

Type declaration

Type declaration

Type declaration

Type declaration

Type declaration

Private Readonly #did

Private Readonly #exchangeRoot

Private Readonly #privateForest

Private Readonly #publicRoot

Private Readonly #shareCounter

Private Readonly #unix

Private Readonly #version

Settings

Member Visibility

Theme

On This Page

`Static` create

`Static` fromCID

`Private` `Readonly` #blockstore

`Private` `Readonly` #did

`Private` `Readonly` #exchangeRoot

`Private` `Readonly` #privateForest

`Private` `Readonly` #publicRoot

`Private` `Readonly` #shareCounter

`Private` `Readonly` #unix

`Private` `Readonly` #version