Skip to content

Commit ea9b081

Browse files
committed
docs: remove all Hypercerts SDK references
Delete the SDK page (pages/tools/sdk.md) and remove all mentions of the Hypercerts SDK across 28 files. Code examples now use @atproto/api directly instead of @hypercerts-org/sdk-core. Navigation and index cards updated accordingly. Build passes cleanly.
1 parent f54b697 commit ea9b081

28 files changed

Lines changed: 340 additions & 739 deletions

lib/navigation.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ export const navigation = [
5252
{
5353
section: "Tools",
5454
children: [
55-
{ title: "Hypercerts SDK", path: "/tools/sdk" },
5655
{ title: "Scaffold Starter App", path: "/tools/scaffold" },
5756
{ title: "Hypercerts CLI", path: "/tools/hypercerts-cli" },
5857
{ title: "Hyperindex", path: "/tools/hyperindex" },

pages/architecture/account-and-identity.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ To set up an organizational account, create an account at [certified.app](https:
6363

6464
### OAuth (for applications)
6565

66-
Applications authenticate users via AT Protocol OAuth. The [Hypercerts SDK](/tools/sdk) handles the full OAuth flow — authorization, token management, and session restoration. Users authorize your app through their PDS and never share credentials with your application. See the [Quickstart](/getting-started/quickstart) for the SDK setup.
66+
Applications authenticate users via AT Protocol OAuth. The AT Protocol client libraries handle the full OAuth flow — authorization, token management, and session restoration. Users authorize your app through their PDS and never share credentials with your application. See the [Quickstart](/getting-started/quickstart) for the authentication setup.
6767

6868
### App passwords (for scripts and CLI)
6969

pages/architecture/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The protocol operates across three layers that work together to enable portable
1313

1414
The **Data Layer** is the foundation. AT Protocol stores claims, attachments, and evaluations. Personal Data Servers (PDS) host user-controlled records — organizations can create dedicated PDS accounts for shared repositories. Relays aggregate data across servers. Indexers build queryable views that applications consume.
1515

16-
The **Application Layer** sits on top of the data layer. Funding platforms, dashboards, and evaluation tools live here. These applications read from and write to the data layer using the [Hypercerts SDK](/tools/sdk) and [Hyperindex](/tools/hyperindex).
16+
The **Application Layer** sits on top of the data layer. Funding platforms, dashboards, and evaluation tools live here. These applications read from and write to the data layer using the [ATProto API](https://atproto.com/docs) and [Hyperindex](/tools/hyperindex).
1717

1818
The **Ownership Layer** is planned but not yet implemented. The intended design uses a freeze-then-fund model where hypercerts are frozen and anchored on-chain before funding — ensuring funders know exactly what they are paying for. See [Funding & Value Flow](/core-concepts/funding-and-value-flow) for details.
1919

pages/core-concepts/funding-and-value-flow.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,4 +139,3 @@ Two years later, a second evaluator, Eve, assesses the health of Alice's trees a
139139
- [Data Flow & Lifecycle](/architecture/data-flow-and-lifecycle) — how a hypercert moves through the system
140140
- [Roadmap](/roadmap) — current build priorities and development phases
141141

142-
Next: [Hypercerts SDK](/tools/sdk) — the TypeScript SDK for building on the Hypercerts protocol.

pages/core-concepts/hypercerts-core-data-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Every hypercert starts with an **activity claim** — the central record that an
2424

2525
In addition to these core dimensions, the activity claim can define the rights that come with this claim. The basic right is just "public display", e.g. bragging rights about financial or non-financial contributions to impact. If the hypercert is tokenized, the field can define how the hypercert is allowed to be transferred.
2626

27-
The activity claim is what you create when you call `repo.hypercerts.create()` in the SDK. It gets a permanent AT-URI like `at://did:plc:alice123/org.hypercerts.claim.activity/3k7`.
27+
The activity claim is the core record you create when making a hypercert. It gets a permanent AT-URI like `at://did:plc:alice123/org.hypercerts.claim.activity/3k7`.
2828

2929
## Additional details
3030

pages/getting-started/building-on-hypercerts.md

Lines changed: 39 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,17 @@ Build services that help domain experts create structured, verifiable evaluation
3838
- Educational outcome measurement for learning programs
3939

4040
```javascript
41-
// Example: Create an evaluation via the SDK
42-
const evaluation = await repo.hypercerts.addEvaluation({
43-
subjectUri: claimUri,
44-
evaluators: [evaluatorDid],
45-
summary: "Scientific rigor and reproducibility assessment",
41+
// Example: Create an evaluation
42+
const evaluation = await agent.com.atproto.repo.createRecord({
43+
repo: agent.session.did,
44+
collection: "org.hypercerts.claim.evaluation",
45+
record: {
46+
subject: { uri: claimUri, cid: claimCid },
47+
evaluators: [evaluatorDid],
48+
summary: "Scientific rigor and reproducibility assessment",
49+
$type: "org.hypercerts.claim.evaluation",
50+
createdAt: new Date().toISOString(),
51+
},
4652
});
4753
```
4854

@@ -111,22 +117,23 @@ Authenticate users via OAuth and write records to their PDS on their behalf.
111117
**When to use:** Tools where users create their own hypercerts, evaluations, or measurements through your interface.
112118

113119
```javascript
114-
// OAuth flow
115-
const session = await sdk.callback(callbackParams);
116-
const repo = sdk.getRepository(session);
120+
// Authenticate via ATProto OAuth
121+
const agent = new AtpAgent({ service: userPdsUrl });
122+
await agent.resumeSession(savedSession);
117123

118124
// Write to user's PDS
119-
await repo.hypercerts.create({
120-
title: "Open source library for data processing",
121-
shortDescription: "Built and maintained a data processing library.",
122-
description: "Developed the core architecture and maintained the library through 3 major releases.",
123-
workScope: "Software Development",
124-
startDate: "2026-01-01T00:00:00Z",
125-
endDate: "2026-06-30T23:59:59Z",
126-
rights: {
127-
name: "Public Display",
128-
type: "display",
129-
description: "Right to publicly display this contribution",
125+
await agent.com.atproto.repo.createRecord({
126+
repo: agent.session.did,
127+
collection: "org.hypercerts.claim.activity",
128+
record: {
129+
title: "Open source library for data processing",
130+
shortDescription: "Built and maintained a data processing library.",
131+
description: "Developed the core architecture and maintained the library through 3 major releases.",
132+
workScope: { allOf: ["Software Development"] },
133+
startDate: "2026-01-01T00:00:00Z",
134+
endDate: "2026-06-30T23:59:59Z",
135+
$type: "org.hypercerts.claim.activity",
136+
createdAt: new Date().toISOString(),
130137
},
131138
});
132139
```
@@ -140,26 +147,20 @@ Create a dedicated organizational account on a PDS and create records under the
140147
**When to use:** Platforms that issue hypercerts on behalf of others, or evaluation services that publish assessments under the platform's authority.
141148

142149
```javascript
143-
// Platform creates claim on behalf of contributor
144-
await repo.hypercerts.create({
145-
title: "Bounty #123: Fix authentication bug",
146-
shortDescription: "Resolved critical authentication vulnerability.",
147-
description: "Identified and patched a session fixation vulnerability in the OAuth callback handler.",
148-
workScope: "Security, Bug Fix",
149-
startDate: "2026-01-15T00:00:00Z",
150-
endDate: "2026-01-20T23:59:59Z",
151-
rights: {
152-
name: "Public Display",
153-
type: "display",
154-
description: "Right to publicly display this contribution",
150+
// Platform creates claim under its own DID
151+
await agent.com.atproto.repo.createRecord({
152+
repo: agent.session.did,
153+
collection: "org.hypercerts.claim.activity",
154+
record: {
155+
title: "Bounty #123: Fix authentication bug",
156+
shortDescription: "Resolved critical authentication vulnerability.",
157+
description: "Identified and patched a session fixation vulnerability in the OAuth callback handler.",
158+
workScope: { allOf: ["Security", "Bug Fix"] },
159+
startDate: "2026-01-15T00:00:00Z",
160+
endDate: "2026-01-20T23:59:59Z",
161+
$type: "org.hypercerts.claim.activity",
162+
createdAt: new Date().toISOString(),
155163
},
156-
contributions: [
157-
{
158-
contributors: [contributorDid],
159-
contributionDetails: "Bug fix author",
160-
weight: "100",
161-
},
162-
],
163164
});
164165
```
165166

@@ -239,15 +240,6 @@ Propose changes to lexicons through the standard process:
239240
The GitHub repository for lexicon proposals will be available soon. Check the [Hypercerts GitHub](https://github.com/hypercerts-org) for updates.
240241
{% /callout %}
241242

242-
### SDK Contributions
243-
244-
The Hypercerts SDK is open source. Contributions welcome:
245-
246-
- Bug fixes and performance improvements
247-
- New helper functions for common operations
248-
- Better TypeScript types and documentation
249-
- Examples and tutorials
250-
251243
### Running a Relay
252244

253245
Help decentralize the network by running a relay node. Relays aggregate events from PDSs and make them available to indexers.

pages/getting-started/common-use-cases.md

Lines changed: 54 additions & 92 deletions
Original file line numberDiff line numberDiff line change
@@ -5,48 +5,31 @@ description: See how hypercerts work for different types of contributions.
55

66
# Common Use Cases
77

8-
Hypercerts work for any kind of impact work. This page shows four common scenarios with real SDK code.
8+
Hypercerts work for any kind of impact work. This page shows four common scenarios with code examples.
99

1010
## Open-source software maintenance
1111

1212
A team maintains a widely-used library. They create a hypercert covering a year of maintenance — bug fixes, documentation updates, and community support.
1313

1414
```typescript
15-
import { createATProtoSDK } from "@hypercerts-org/sdk-core";
16-
17-
const sdk = createATProtoSDK({ /* oauth config */ });
18-
const session = await sdk.restoreSession("did:plc:abc123");
19-
const repo = sdk.getRepository(session);
20-
21-
const result = await repo.hypercerts.create({
22-
title: "Library maintenance, 2025",
23-
shortDescription: "Ongoing maintenance of an open-source library",
24-
description: "Fixed 47 bugs, reviewed 120 pull requests, updated documentation, and provided community support on Discord.",
25-
workScope: "Software Development, Open Source",
26-
startDate: "2025-01-01T00:00:00Z",
27-
endDate: "2025-12-31T23:59:59Z",
28-
rights: {
29-
name: "Public Display",
30-
type: "display",
31-
description: "Right to publicly display this contribution",
15+
import { AtpAgent } from "@atproto/api";
16+
17+
const agent = new AtpAgent({ service: "https://bsky.social" });
18+
await agent.login({ identifier: "your-handle.certified.app", password: "your-app-password" });
19+
20+
const result = await agent.com.atproto.repo.createRecord({
21+
repo: agent.session.did,
22+
collection: "org.hypercerts.claim.activity",
23+
record: {
24+
title: "Library maintenance, 2025",
25+
shortDescription: "Ongoing maintenance of an open-source library",
26+
description: "Fixed 47 bugs, reviewed 120 pull requests, updated documentation, and provided community support on Discord.",
27+
workScope: { allOf: ["Software Development", "Open Source"] },
28+
startDate: "2025-01-01T00:00:00Z",
29+
endDate: "2025-12-31T23:59:59Z",
30+
$type: "org.hypercerts.claim.activity",
31+
createdAt: new Date().toISOString(),
3232
},
33-
contributions: [
34-
{
35-
contributors: ["did:plc:alice123"],
36-
contributionDetails: "Core developer",
37-
weight: "50",
38-
},
39-
{
40-
contributors: ["did:plc:bob456"],
41-
contributionDetails: "Documentation lead",
42-
weight: "30",
43-
},
44-
{
45-
contributors: ["did:plc:carol789"],
46-
contributionDetails: "Community manager",
47-
weight: "20",
48-
},
49-
],
5033
});
5134
```
5235

@@ -57,25 +40,19 @@ After creating the hypercert, the team attaches links to the repository, release
5740
A conservation group restores degraded forest over several years. They document the work with location data and measurements.
5841

5942
```typescript
60-
const result = await repo.hypercerts.create({
61-
title: "Forest restoration project, 2020–2025",
62-
shortDescription: "Reforestation and biodiversity recovery in degraded tropical forest",
63-
description: "Restored 200 hectares of degraded tropical forest through native species planting, invasive species removal, and community stewardship programs.",
64-
workScope: "Ecosystem Restoration, Biodiversity Conservation",
65-
startDate: "2020-01-01T00:00:00Z",
66-
endDate: "2025-12-31T23:59:59Z",
67-
rights: {
68-
name: "Public Display",
69-
type: "display",
70-
description: "Right to publicly display this contribution",
43+
const result = await agent.com.atproto.repo.createRecord({
44+
repo: agent.session.did,
45+
collection: "org.hypercerts.claim.activity",
46+
record: {
47+
title: "Forest restoration project, 2020–2025",
48+
shortDescription: "Reforestation and biodiversity recovery in degraded tropical forest",
49+
description: "Restored 200 hectares of degraded tropical forest through native species planting, invasive species removal, and community stewardship programs.",
50+
workScope: { allOf: ["Ecosystem Restoration", "Biodiversity Conservation"] },
51+
startDate: "2020-01-01T00:00:00Z",
52+
endDate: "2025-12-31T23:59:59Z",
53+
$type: "org.hypercerts.claim.activity",
54+
createdAt: new Date().toISOString(),
7155
},
72-
locations: [{
73-
lpVersion: "1",
74-
srs: "EPSG:4326",
75-
locationType: "coordinate-decimal",
76-
location: "-84.10, 10.42",
77-
name: "Restoration site",
78-
}],
7956
});
8057
```
8158

@@ -86,35 +63,19 @@ The group then adds measurement records tracking hectares restored, native speci
8663
A research team completes a multi-year study and wants to document the effort with clear contributor roles.
8764

8865
```typescript
89-
const result = await repo.hypercerts.create({
90-
title: "Drug delivery mechanism research, 2022–2024",
91-
shortDescription: "Novel approaches to improving therapeutic delivery",
92-
description: "Developed and tested three novel nanoparticle-based drug delivery mechanisms, resulting in two published papers and one patent application.",
93-
workScope: "Biomedical Research, Drug Delivery",
94-
startDate: "2022-03-01T00:00:00Z",
95-
endDate: "2024-11-30T23:59:59Z",
96-
rights: {
97-
name: "Public Display",
98-
type: "display",
99-
description: "Right to publicly display this contribution",
66+
const result = await agent.com.atproto.repo.createRecord({
67+
repo: agent.session.did,
68+
collection: "org.hypercerts.claim.activity",
69+
record: {
70+
title: "Drug delivery mechanism research, 2022–2024",
71+
shortDescription: "Novel approaches to improving therapeutic delivery",
72+
description: "Developed and tested three novel nanoparticle-based drug delivery mechanisms, resulting in two published papers and one patent application.",
73+
workScope: { allOf: ["Biomedical Research", "Drug Delivery"] },
74+
startDate: "2022-03-01T00:00:00Z",
75+
endDate: "2024-11-30T23:59:59Z",
76+
$type: "org.hypercerts.claim.activity",
77+
createdAt: new Date().toISOString(),
10078
},
101-
contributions: [
102-
{
103-
contributors: ["did:plc:pi001"],
104-
contributionDetails: "Principal investigator",
105-
weight: "40",
106-
},
107-
{
108-
contributors: ["did:plc:postdoc002"],
109-
contributionDetails: "Postdoctoral researcher",
110-
weight: "35",
111-
},
112-
{
113-
contributors: ["did:plc:grad003"],
114-
contributionDetails: "Graduate student",
115-
weight: "25",
116-
},
117-
],
11879
});
11980
```
12081

@@ -125,17 +86,18 @@ Attachments link to the published paper (via DOI), lab notebooks, and experiment
12586
A group runs regular workshops teaching practical skills to underrepresented communities. They want to document their educational impact.
12687

12788
```typescript
128-
const result = await repo.hypercerts.create({
129-
title: "Community workshops, 2025",
130-
shortDescription: "Free skill-building workshops for underrepresented groups",
131-
description: "Organized and delivered 24 free workshops covering web development, data literacy, and career skills to 450 participants from underrepresented communities.",
132-
workScope: "Education, Community Building",
133-
startDate: "2025-01-01T00:00:00Z",
134-
endDate: "2025-12-31T23:59:59Z",
135-
rights: {
136-
name: "Public Display",
137-
type: "display",
138-
description: "Right to publicly display this contribution",
89+
const result = await agent.com.atproto.repo.createRecord({
90+
repo: agent.session.did,
91+
collection: "org.hypercerts.claim.activity",
92+
record: {
93+
title: "Community workshops, 2025",
94+
shortDescription: "Free skill-building workshops for underrepresented groups",
95+
description: "Organized and delivered 24 free workshops covering web development, data literacy, and career skills to 450 participants from underrepresented communities.",
96+
workScope: { allOf: ["Education", "Community Building"] },
97+
startDate: "2025-01-01T00:00:00Z",
98+
endDate: "2025-12-31T23:59:59Z",
99+
$type: "org.hypercerts.claim.activity",
100+
createdAt: new Date().toISOString(),
139101
},
140102
});
141103
```

0 commit comments

Comments
 (0)