stated-protocol 5.0.0 → 5.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -10
- package/package.json +2 -3
package/README.md
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# Stated Protocol Parser
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/stated-protocol)
|
|
4
4
|
|
|
5
5
|
A TypeScript library for parsing and formatting statements in the Stated protocol - a decentralized statement verification system.
|
|
6
6
|
|
|
7
7
|
## Installation
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
npm install stated-protocol
|
|
10
|
+
npm install stated-protocol
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
## Features
|
|
@@ -32,7 +32,7 @@ npm install stated-protocol-parser
|
|
|
32
32
|
### Basic Statement
|
|
33
33
|
|
|
34
34
|
```typescript
|
|
35
|
-
import { buildStatement, parseStatement } from 'stated-protocol
|
|
35
|
+
import { buildStatement, parseStatement } from 'stated-protocol';
|
|
36
36
|
|
|
37
37
|
// Build a statement
|
|
38
38
|
const statement = buildStatement({
|
|
@@ -62,7 +62,7 @@ import {
|
|
|
62
62
|
buildSignedStatement,
|
|
63
63
|
verifySignedStatement,
|
|
64
64
|
parseSignedStatement
|
|
65
|
-
} from 'stated-protocol
|
|
65
|
+
} from 'stated-protocol/node';
|
|
66
66
|
|
|
67
67
|
// Generate a key pair
|
|
68
68
|
const { publicKey, privateKey } = generateKeyPair();
|
|
@@ -97,7 +97,7 @@ import {
|
|
|
97
97
|
generateKeyPair,
|
|
98
98
|
buildSignedStatement,
|
|
99
99
|
verifySignedStatement
|
|
100
|
-
} from 'stated-protocol
|
|
100
|
+
} from 'stated-protocol';
|
|
101
101
|
|
|
102
102
|
// Generate a key pair (async in browser)
|
|
103
103
|
const { publicKey, privateKey } = await generateKeyPair();
|
|
@@ -137,7 +137,7 @@ Algorithm: Ed25519
|
|
|
137
137
|
### Poll
|
|
138
138
|
|
|
139
139
|
```typescript
|
|
140
|
-
import { buildPollContent, parsePoll } from 'stated-protocol
|
|
140
|
+
import { buildPollContent, parsePoll } from 'stated-protocol';
|
|
141
141
|
|
|
142
142
|
const pollContent = buildPollContent({
|
|
143
143
|
poll: 'Should we implement feature X?',
|
|
@@ -152,7 +152,7 @@ const parsed = parsePoll(pollContent);
|
|
|
152
152
|
### Organisation Verification
|
|
153
153
|
|
|
154
154
|
```typescript
|
|
155
|
-
import { buildOrganisationVerificationContent, parseOrganisationVerification } from 'stated-protocol
|
|
155
|
+
import { buildOrganisationVerificationContent, parseOrganisationVerification } from 'stated-protocol';
|
|
156
156
|
|
|
157
157
|
const verification = buildOrganisationVerificationContent({
|
|
158
158
|
name: 'Example Corp',
|
|
@@ -167,7 +167,7 @@ const verification = buildOrganisationVerificationContent({
|
|
|
167
167
|
### Person Verification
|
|
168
168
|
|
|
169
169
|
```typescript
|
|
170
|
-
import { buildPersonVerificationContent, parsePersonVerification } from 'stated-protocol
|
|
170
|
+
import { buildPersonVerificationContent, parsePersonVerification } from 'stated-protocol';
|
|
171
171
|
|
|
172
172
|
const verification = buildPersonVerificationContent({
|
|
173
173
|
name: 'John Doe',
|
|
@@ -208,7 +208,7 @@ import {
|
|
|
208
208
|
legalForms,
|
|
209
209
|
peopleCountBuckets,
|
|
210
210
|
UTCFormat
|
|
211
|
-
} from 'stated-protocol
|
|
211
|
+
} from 'stated-protocol';
|
|
212
212
|
```
|
|
213
213
|
|
|
214
214
|
### Types
|
|
@@ -227,7 +227,7 @@ import type {
|
|
|
227
227
|
ResponseContent,
|
|
228
228
|
PDFSigning,
|
|
229
229
|
Rating
|
|
230
|
-
} from 'stated-protocol
|
|
230
|
+
} from 'stated-protocol';
|
|
231
231
|
```
|
|
232
232
|
|
|
233
233
|
## Format Specifications
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "stated-protocol",
|
|
3
|
-
"version": "5.0.
|
|
3
|
+
"version": "5.0.1",
|
|
4
4
|
"description": "Protocol for Decentralised Interorganisational Coordination",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/esm/index.js",
|
|
@@ -9,8 +9,7 @@
|
|
|
9
9
|
".": {
|
|
10
10
|
"types": "./dist/index.d.ts",
|
|
11
11
|
"import": "./dist/esm/index.js",
|
|
12
|
-
"require": "./dist/index.js"
|
|
13
|
-
"default": "./dist/index.js"
|
|
12
|
+
"require": "./dist/index.js"
|
|
14
13
|
}
|
|
15
14
|
},
|
|
16
15
|
"scripts": {
|