Class TransactionContext

Querying

ls

ls: {
    (path, listOptions): Promise<DirectoryItemWithKind[]>;
    (path, listOptions): Promise<DirectoryItem[]>;
    (path): Promise<DirectoryItem[]>;
    (path, listOptions?): Promise<DirectoryItem[] | DirectoryItemWithKind[]>;
} = ...

Type declaration

- (path, listOptions): Promise<DirectoryItemWithKind[]>
- Parameters
  - path: [Partition, ...string[]]
  - listOptions: {
    withItemKind: true;
    }
    - withItemKind: true
  Returns Promise<DirectoryItemWithKind[]>
- (path, listOptions): Promise<DirectoryItem[]>
- Parameters
  - path: [Partition, ...string[]]
  - listOptions: {
    withItemKind: false;
    }
    - withItemKind: false
  Returns Promise<DirectoryItem[]>
- (path): Promise<DirectoryItem[]>
- Parameters
  - path: [Partition, ...string[]]
  Returns Promise<DirectoryItem[]>
- (path, listOptions?): Promise<DirectoryItem[] | DirectoryItemWithKind[]>
- Parameters
  - path: [Partition, ...string[]]
  - Optional listOptions: {
    withItemKind: boolean;
    }
    - withItemKind: boolean
  Returns Promise<DirectoryItem[] | DirectoryItemWithKind[]>

capsuleCID

capsuleCID(path): Promise<undefined | CID<unknown, number, number, Version>>
Parameters
- path: [Path.Public, ...string[]]
Returns Promise<undefined | CID<unknown, number, number, Version>>
- Defined in packages/nest/src/transaction.ts:162

capsuleKey

capsuleKey(path): Promise<undefined | Uint8Array>
Parameters
- path: [Path.Private, ...string[]]
Returns Promise<undefined | Uint8Array>
- Defined in packages/nest/src/transaction.ts:170

contentCID

contentCID(path): Promise<undefined | CID<unknown, number, number, Version>>
Parameters
- path: [Path.Public, ...string[]]
Returns Promise<undefined | CID<unknown, number, number, Version>>
- Defined in packages/nest/src/transaction.ts:154

exists

exists(path): Promise<boolean>
Parameters
- path: [Partition, ...string[]]
Returns Promise<boolean>
- Defined in packages/nest/src/transaction.ts:218

listDirectory

listDirectory(path, listOptions): Promise<DirectoryItemWithKind[]>
Parameters
- path: [Partition, ...string[]]
- listOptions: {
  withItemKind: true;
  }
  - withItemKind: true
Returns Promise<DirectoryItemWithKind[]>
- Defined in packages/nest/src/transaction.ts:226
listDirectory(path, listOptions): Promise<DirectoryItem[]>
Parameters
- path: [Partition, ...string[]]
- listOptions: {
  withItemKind: false;
  }
  - withItemKind: false
Returns Promise<DirectoryItem[]>
- Defined in packages/nest/src/transaction.ts:230
listDirectory(path): Promise<DirectoryItem[]>
Parameters
- path: [Partition, ...string[]]
Returns Promise<DirectoryItem[]>
- Defined in packages/nest/src/transaction.ts:234
listDirectory(path, listOptions?): Promise<DirectoryItem[] | DirectoryItemWithKind[]>
Parameters
- path: [Partition, ...string[]]
- Optional listOptions: {
  withItemKind: boolean;
  }
  - withItemKind: boolean
Returns Promise<DirectoryItem[] | DirectoryItemWithKind[]>
- Defined in packages/nest/src/transaction.ts:235

read

read<D, V>(arg, dataType, options?): Promise<DataForType<D, V>>
Type Parameters
- D extends DataType
- V = unknown
Parameters
- arg: [Partition, string, ...string[]] | {
      contentCID: CID<unknown, number, number, Version>;
  } | {
      capsuleCID: CID<unknown, number, number, Version>;
  } | {
      capsuleKey: Uint8Array;
  }
- dataType: D
- Optional options: {
  length?: number;
  offset?: number;
  }
  - Optional length?: number
  - Optional offset?: number
Returns Promise<DataForType<D, V>>
- Defined in packages/nest/src/transaction.ts:260

size

size(path): Promise<number>
Parameters
- path: [Partition, string, ...string[]]
Returns Promise<number>
- Defined in packages/nest/src/transaction.ts:334

Mutating

cp

cp: ((fromParam, toParam) => Promise<void>) = ...

Type declaration

- (fromParam, toParam): Promise<void>
- Parameters
  - fromParam: [Partition, string, ...string[]]
  - toParam: [Partition, ...string[]] | [Partition, string, ...string[]]
  Returns Promise<void>

mkdir

mkdir: ((path) => Promise<void>) = ...

Type declaration

- (path): Promise<void>
- Parameters
  - path: [Partition, string, ...string[]]
  Returns Promise<void>

mv

mv: ((fromParam, toParam) => Promise<void>) = ...

Type declaration

- (fromParam, toParam): Promise<void>
- Parameters
  - fromParam: [Partition, string, ...string[]]
  - toParam: [Partition, ...string[]] | [Partition, string, ...string[]]
  Returns Promise<void>

rm

rm: ((path) => Promise<void>) = ...

Type declaration

- (path): Promise<void>
- Parameters
  - path: [Partition, string, ...string[]]
  Returns Promise<void>

copy

copy(fromParam, toParam): Promise<void>
Parameters
- fromParam: [Partition, string, ...string[]]
- toParam: [Partition, ...string[]] | [Partition, string, ...string[]]
Returns Promise<void>
- Defined in packages/nest/src/transaction.ts:348

createDirectory

createDirectory(path): Promise<{
path: [Partition, string, ...string[]];
}>
Parameters
- path: [Partition, string, ...string[]]
Returns Promise<{
path: [Partition, string, ...string[]];
}>
- Defined in packages/nest/src/transaction.ts:381

createFile

createFile<D, V>(path, dataType, data): Promise<{
path: [Partition, string, ...string[]];
}>
Type Parameters
- D extends DataType
- V = unknown
Parameters
- path: [Partition, string, ...string[]]
- dataType: DataType
- data: DataForType<D, V>
Returns Promise<{
path: [Partition, string, ...string[]];
}>
- Defined in packages/nest/src/transaction.ts:399

ensureDirectory

ensureDirectory(path): Promise<void>
Parameters
- path: [Partition, string, ...string[]]
Returns Promise<void>
- Defined in packages/nest/src/transaction.ts:417

move

move(fromParam, toParam): Promise<void>
Parameters
- fromParam: [Partition, string, ...string[]]
- toParam: [Partition, ...string[]] | [Partition, string, ...string[]]
Returns Promise<void>
- Defined in packages/nest/src/transaction.ts:449

remove

remove(path): Promise<void>
Parameters
- path: [Partition, string, ...string[]]
Returns Promise<void>
- Defined in packages/nest/src/transaction.ts:466

rename

rename(path, newName): Promise<void>
Parameters
- path: [Partition, string, ...string[]]
- newName: string
Returns Promise<void>
- Defined in packages/nest/src/transaction.ts:498

write

write<D, V>(path, dataType, data): Promise<void>
Type Parameters
- D extends DataType
- V = unknown
Parameters
- path: [Partition, string, ...string[]]
- dataType: DataType
- data: DataForType<D, V>
Returns Promise<void>
- Defined in packages/nest/src/transaction.ts:514

Methods

`Private` #manualCopyDirectory

#manualCopyDirectory(from, to): Promise<void>
Parameters
- from: [Partition, string, ...string[]]
- to: [Partition, ...string[]]
Returns Promise<void>
- Defined in packages/nest/src/transaction.ts:812

`Private` #manualCopyFile

#manualCopyFile(from, to): Promise<void>
Parameters
- from: [Partition, string, ...string[]]
- to: [Partition, string, ...string[]]
Returns Promise<void>
- Defined in packages/nest/src/transaction.ts:805

`Private` #manualMove

#manualMove(from, to): Promise<void>
Parameters
- from: [Partition, string, ...string[]]
- to: [Partition, ...string[]] | [Partition, string, ...string[]]
Returns Promise<void>
- Defined in packages/nest/src/transaction.ts:844

`Private` #privateContext

#privateContext(): PrivateContext
Returns PrivateContext
- Defined in packages/nest/src/transaction.ts:924

`Private` #privateMutation

#privateMutation(path, mut, mutType): Promise<void>
Parameters
- path: [Path.Private, ...string[]]
- mut: Private
- mutType: MutationType
Returns Promise<void>
- Defined in packages/nest/src/transaction.ts:877

`Private` #publicContext

#publicContext(): PublicContext
Returns PublicContext
- Defined in packages/nest/src/transaction.ts:917

`Private` #publicMutation

#publicMutation(path, mut, mutType): Promise<void>
Parameters
- path: [Path.Public, ...string[]]
- mut: Public
- mutType: MutationType
Returns Promise<void>
- Defined in packages/nest/src/transaction.ts:852

`Private` #query

#query<T>(path, queryFunctions): Promise<T>
Type Parameters
- T
Parameters
- path: [Partition, ...string[]]
- queryFunctions: {
  private: Private<T>;
  public: Public<T>;
  }
  - private: Private<T>
  - public: Public<T>
Returns Promise<T>
- Defined in packages/nest/src/transaction.ts:775

assignIdentifier

assignIdentifier(did): Promise<void>
Parameters
- did: string
Returns Promise<void>
- Defined in packages/nest/src/transaction.ts:545

identifier

identifier(): undefined | string
Returns undefined | string
- Defined in packages/nest/src/transaction.ts:549

Properties

`Private` `Readonly` #blockstore

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

Type declaration

`Private` `Readonly` #modifications

#modifications: Set<{
path: [Partition, ...string[]];
type: MutationType;
}>

Type declaration

path: [Partition, ...string[]]
type: MutationType

`Private` `Readonly` #onCommit

#onCommit: CommitVerifier

`Private` #privateNodes

#privateNodes: MountedPrivateNodes

`Private` `Readonly` #rng

#rng: Rng

`Private` #rootTree

#rootTree: RootTree

Sharing

isExchangeKeyRegistered

isExchangeKeyRegistered(exchangePublicKey): Promise<boolean>
Check if an exchange key was already registered.
Parameters
- exchangePublicKey: Uint8Array | CryptoKey
Returns Promise<boolean>
- Defined in packages/nest/src/transaction.ts:561

receive

receive(sharerDataRoot, exchangeKeyPair, opts?): Promise<Share>
Load a shared item.

NOTE: A share can only be received if the exchange key was registered and the receiver is in possession of the associated private key.
Parameters
- sharerDataRoot: CID<unknown, number, number, Version>
  The data root CID from the sharer
- exchangeKeyPair: {
  privateKey: CryptoKey;
  publicKey: Uint8Array | CryptoKey;
  }
  A RSA-OAEP-256 key pair
  - privateKey: CryptoKey
    A RSA-OAEP-256 private key in the form of a CryptoKey
  - publicKey: Uint8Array | CryptoKey
    A RSA-OAEP-256 public key in the form of a CryptoKey or its modulus bytes
- opts: {
      shareId?: string;
      sharerBlockstore?: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
      sharerRootTreeClass?: typeof RootTree;
  } = {}
  Optional overrides
  - Optional shareId?: string
    Specify what shareId to use, otherwise this'll load the last share that was made to the given exchange key.
  - Optional sharerBlockstore?: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>
    Specify what blockstore to use to load the sharer's file system.
  - Optional sharerRootTreeClass?: typeof RootTree
    Specify what root tree class was used for the sharer's file system.
Returns Promise<Share>
- Defined in packages/nest/src/transaction.ts:609

registerExchangeKey

registerExchangeKey(name, exchangePublicKey): Promise<Uint8Array>
Register an exchange key.
Parameters
- name: string
  A name for the key (using an existing name overrides the old key)
- exchangePublicKey: Uint8Array | CryptoKey
  A RSA-OAEP-256 public key in the form of a CryptoKey or its modulus bytes
Returns Promise<Uint8Array>
- Defined in packages/nest/src/transaction.ts:650

share(path, receiverDataRoot, opts?): Promise<{
shareId: string;
}>
Share a private file or directory.

NOTE: A share can only be received if the exchange key was registered and the receiver is in possession of the associated private key.
Parameters
- path: [Path.Private, ...string[]]
  Path to the private file or directory to share (with 'private' prefix)
- receiverDataRoot: CID<unknown, number, number, Version>
  Data root CID of the receiver
- opts: {
  receiverBlockstore?: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>;
  receiverRootTreeClass?: typeof RootTree;
  } = {}
  Optional overrides
  - Optional receiverBlockstore?: Blockstore<{}, {}, {}, {}, {}, {}, {}, {}>
    Specify what blockstore to use to load the receiver's file system
  - Optional receiverRootTreeClass?: typeof RootTree
    Specify what root tree class was used for the receiver's file system
Returns Promise<{
shareId: string;
}>
- Defined in packages/nest/src/transaction.ts:689

Class TransactionContext

Index

Querying

Mutating

Methods

Properties

Sharing

Querying

ls

Type declaration

Parameters

withItemKind: true

Returns Promise<DirectoryItemWithKind[]>

Parameters

withItemKind: false

Returns Promise<DirectoryItem[]>

Parameters

Returns Promise<DirectoryItem[]>

Parameters

withItemKind: boolean

Returns Promise<DirectoryItem[] | DirectoryItemWithKind[]>

capsuleCID

Parameters

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

capsuleKey

Parameters

Returns Promise<undefined | Uint8Array>

contentCID

Parameters

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

exists

Parameters

Returns Promise<boolean>

listDirectory

Parameters

withItemKind: true

Returns Promise<DirectoryItemWithKind[]>

Parameters

withItemKind: false

Returns Promise<DirectoryItem[]>

Parameters

Returns Promise<DirectoryItem[]>

Parameters

withItemKind: boolean

Returns Promise<DirectoryItem[] | DirectoryItemWithKind[]>

read

Type Parameters

Parameters

Optional length?: number

Optional offset?: number

Returns Promise<DataForType<D, V>>

size

Parameters

Returns Promise<number>

Mutating

cp

Type declaration

Parameters

Returns Promise<void>

mkdir

Type declaration

Parameters

Returns Promise<void>

mv

Type declaration

Parameters

Returns Promise<void>

rm

Type declaration

Parameters

Returns Promise<void>

copy

Parameters

Returns Promise<void>

createDirectory

Parameters

Returns Promise<{ path: [Partition, string, ...string[]]; }>

createFile

Type Parameters

Parameters

`Optional` length?: number

`Optional` offset?: number

Returns Promise<{
path: [Partition, string, ...string[]];
}>

Returns Promise<{
path: [Partition, string, ...string[]];
}>

`Private` #manualCopyDirectory

`Private` #manualCopyFile

`Private` #manualMove

`Private` #privateContext

`Private` #privateMutation

`Private` #publicContext

`Private` #publicMutation

`Private` #query

`Private` `Readonly` #blockstore

`Private` `Readonly` #modifications

`Private` `Readonly` #onCommit

`Private` #privateNodes

`Private` `Readonly` #rng

`Private` #rootTree