Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update dht op types #253

Merged
merged 3 commits into from
Jun 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
### Added
### Changed
### Fixed
- `DhtOp` was split into `ChainOp` and `WarrantOp` in Holochain.
### Removed

## 2024-06-11: v0.18.0-dev.2
Expand Down
15 changes: 15 additions & 0 deletions docs/client.actionhashandsig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [ActionHashAndSig](./client.actionhashandsig.md)

## ActionHashAndSig type

Action hash with the signature of the action at that hash

**Signature:**

```typescript
export type ActionHashAndSig = [ActionHash, Signature];
```
**References:** [ActionHash](./client.actionhash.md)<!-- -->, [Signature](./client.signature.md)

25 changes: 25 additions & 0 deletions docs/client.chainintegritywarrant.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [ChainIntegrityWarrant](./client.chainintegritywarrant.md)

## ChainIntegrityWarrant type


**Signature:**

```typescript
export type ChainIntegrityWarrant = {
InvalidChainOp: {
action_author: AgentPubKey;
action: ActionHashAndSig;
validation_type: ValidationType;
} | {
ChainFork: {
chain_author: AgentPubKey;
action_pair: [ActionHashAndSig, ActionHashAndSig];
};
};
};
```
**References:** [AgentPubKey](./client.agentpubkey.md)<!-- -->, [ActionHashAndSig](./client.actionhashandsig.md)<!-- -->, [ValidationType](./client.validationtype.md)

36 changes: 36 additions & 0 deletions docs/client.chainop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [ChainOp](./client.chainop.md)

## ChainOp type


**Signature:**

```typescript
export type ChainOp = {
[DhtOpType.StoreRecord]: [Signature, Action, Entry | undefined];
} | {
[DhtOpType.StoreEntry]: [Signature, NewEntryAction, Entry];
} | {
[DhtOpType.RegisterAgentActivity]: [Signature, Action];
} | {
[DhtOpType.RegisterUpdatedContent]: [
Signature,
Update,
Entry | undefined
];
} | {
[DhtOpType.RegisterUpdatedRecord]: [Signature, Update, Entry | undefined];
} | {
[DhtOpType.RegisterDeletedBy]: [Signature, Delete];
} | {
[DhtOpType.RegisterDeletedEntryAction]: [Signature, Delete];
} | {
[DhtOpType.RegisterAddLink]: [Signature, CreateLink];
} | {
[DhtOpType.RegisterRemoveLink]: [Signature, DeleteLink];
};
```
**References:** [DhtOpType.StoreRecord](./client.dhtoptype.md)<!-- -->, [Signature](./client.signature.md)<!-- -->, [Action](./client.action.md)<!-- -->, [Entry](./client.entry.md)<!-- -->, [DhtOpType.StoreEntry](./client.dhtoptype.md)<!-- -->, [NewEntryAction](./client.newentryaction.md)<!-- -->, [DhtOpType.RegisterAgentActivity](./client.dhtoptype.md)<!-- -->, [DhtOpType.RegisterUpdatedContent](./client.dhtoptype.md)<!-- -->, [Update](./client.update.md)<!-- -->, [DhtOpType.RegisterUpdatedRecord](./client.dhtoptype.md)<!-- -->, [DhtOpType.RegisterDeletedBy](./client.dhtoptype.md)<!-- -->, [Delete](./client.delete.md)<!-- -->, [DhtOpType.RegisterDeletedEntryAction](./client.dhtoptype.md)<!-- -->, [DhtOpType.RegisterAddLink](./client.dhtoptype.md)<!-- -->, [CreateLink](./client.createlink.md)<!-- -->, [DhtOpType.RegisterRemoveLink](./client.dhtoptype.md)<!-- -->, [DeleteLink](./client.deletelink.md)

24 changes: 3 additions & 21 deletions docs/client.dhtop.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,28 +9,10 @@

```typescript
export type DhtOp = {
[DhtOpType.StoreRecord]: [Signature, Action, Entry | undefined];
ChainOp: ChainOp;
} | {
[DhtOpType.StoreEntry]: [Signature, NewEntryAction, Entry];
} | {
[DhtOpType.RegisterAgentActivity]: [Signature, Action];
} | {
[DhtOpType.RegisterUpdatedContent]: [
Signature,
Update,
Entry | undefined
];
} | {
[DhtOpType.RegisterUpdatedRecord]: [Signature, Update, Entry | undefined];
} | {
[DhtOpType.RegisterDeletedBy]: [Signature, Delete];
} | {
[DhtOpType.RegisterDeletedEntryAction]: [Signature, Delete];
} | {
[DhtOpType.RegisterAddLink]: [Signature, CreateLink];
} | {
[DhtOpType.RegisterRemoveLink]: [Signature, DeleteLink];
WarrantOp: WarrantOp;
};
```
**References:** [DhtOpType.StoreRecord](./client.dhtoptype.md)<!-- -->, [Signature](./client.signature.md)<!-- -->, [Action](./client.action.md)<!-- -->, [Entry](./client.entry.md)<!-- -->, [DhtOpType.StoreEntry](./client.dhtoptype.md)<!-- -->, [NewEntryAction](./client.newentryaction.md)<!-- -->, [DhtOpType.RegisterAgentActivity](./client.dhtoptype.md)<!-- -->, [DhtOpType.RegisterUpdatedContent](./client.dhtoptype.md)<!-- -->, [Update](./client.update.md)<!-- -->, [DhtOpType.RegisterUpdatedRecord](./client.dhtoptype.md)<!-- -->, [DhtOpType.RegisterDeletedBy](./client.dhtoptype.md)<!-- -->, [Delete](./client.delete.md)<!-- -->, [DhtOpType.RegisterDeletedEntryAction](./client.dhtoptype.md)<!-- -->, [DhtOpType.RegisterAddLink](./client.dhtoptype.md)<!-- -->, [CreateLink](./client.createlink.md)<!-- -->, [DhtOpType.RegisterRemoveLink](./client.dhtoptype.md)<!-- -->, [DeleteLink](./client.deletelink.md)
**References:** [ChainOp](./client.chainop.md)<!-- -->, [WarrantOp](./client.warrantop.md)

61 changes: 61 additions & 0 deletions docs/client.md
Original file line number Diff line number Diff line change
Expand Up @@ -1038,6 +1038,26 @@ Description



</td></tr>
<tr><td>

[Warrant](./client.warrant.md)


</td><td>



</td></tr>
<tr><td>

[WarrantOp](./client.warrantop.md)


</td><td>



</td></tr>
<tr><td>

Expand Down Expand Up @@ -1152,6 +1172,17 @@ Description



</td></tr>
<tr><td>

[ActionHashAndSig](./client.actionhashandsig.md)


</td><td>

Action hash with the signature of the action at that hash


</td></tr>
<tr><td>

Expand Down Expand Up @@ -1553,6 +1584,26 @@ This type is meant to be opaque



</td></tr>
<tr><td>

[ChainIntegrityWarrant](./client.chainintegritywarrant.md)


</td><td>



</td></tr>
<tr><td>

[ChainOp](./client.chainop.md)


</td><td>



</td></tr>
<tr><td>

Expand Down Expand Up @@ -2604,6 +2655,16 @@ An internal link type index within the DNA, from 0 to 255.



</td></tr>
<tr><td>

[ValidationType](./client.validationtype.md)


</td><td>



</td></tr>
<tr><td>

Expand Down
15 changes: 15 additions & 0 deletions docs/client.validationtype.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [ValidationType](./client.validationtype.md)

## ValidationType type


**Signature:**

```typescript
export type ValidationType = {
Sys: null;
App: null;
};
```
13 changes: 13 additions & 0 deletions docs/client.warrant.chainintegrity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [Warrant](./client.warrant.md) &gt; [ChainIntegrity](./client.warrant.chainintegrity.md)

## Warrant.ChainIntegrity property

Signifies evidence of a breach of chain integrity

**Signature:**

```typescript
ChainIntegrity: ChainIntegrityWarrant;
```
56 changes: 56 additions & 0 deletions docs/client.warrant.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [Warrant](./client.warrant.md)

## Warrant interface


**Signature:**

```typescript
export interface Warrant
```

## Properties

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[ChainIntegrity](./client.warrant.chainintegrity.md)


</td><td>


</td><td>

[ChainIntegrityWarrant](./client.chainintegritywarrant.md)


</td><td>

Signifies evidence of a breach of chain integrity


</td></tr>
</tbody></table>
13 changes: 13 additions & 0 deletions docs/client.warrantop.author.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@holochain/client](./client.md) &gt; [WarrantOp](./client.warrantop.md) &gt; [author](./client.warrantop.author.md)

## WarrantOp.author property

author of the warrant

**Signature:**

```typescript
author: AgentPubKey;
```
Loading
Loading