Skip to content

Commit e17997c

Browse files
authored
fix(docs): Make GitHub Happy With Docs Dir (#212)
* Add Docs Dir Back to Make GitHub Happy * Update README * Specify rootDir * Formattooorrr
1 parent 123e82b commit e17997c

File tree

5 files changed

+7
-28
lines changed

5 files changed

+7
-28
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The package needs to be configured with your account's API key, which is availab
3939

4040
```ts
4141
// Replace imports in a production setting
42-
import { createHelius } from "../../src/rpc/index";
42+
import { createHelius } from "helius-sdk";
4343

4444
(async () => {
4545
const apiKey = ""; // From Helius dashboard
@@ -60,7 +60,7 @@ import { createHelius } from "../../src/rpc/index";
6060
})();
6161
```
6262

63-
### Migrating to helius-sdk 2.0.0
63+
### Migrating to `helius-sdk` 2.0.0
6464
The Helius Node.js SDK has been rewritten from the ground up in version 2.0.0 to use [`@solana/kit` (i.e., Kit)](https://www.npmjs.com/package/@solana/kit) under the hood, replacing the dependency on `@solana/web3.js` versions higher than 1.73.2.
6565

6666
We've gone to great lengths to ensure that the developer experience remains largely the same, with minimal impact on existing code. The API methods and namespaces are designed to be intuitive and an improvement on previous versions, so migrating to the latest version is relatively straightforward. There are a plethora of examples found in the `examples` directory, organized by namespace, to aid in this migration.

docs/_config.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
title: Helius SDK
2+
theme: jekyll-theme-primer
3+
plugins:
4+
- jekyll-redirect-from

docs/index.md

Whitespace-only changes.

examples/zk/getMultipleNewAddressProofsV2.ts

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -25,29 +25,3 @@ import { createHelius } from "helius-sdk";
2525
console.error("Error with RPC: ", error);
2626
}
2727
})();
28-
29-
30-
(async () => {
31-
const apiKey = "3a4c1aff-f2ac-48a3-b9ca-65814a7bbeb7";
32-
const helius = createHelius({ apiKey });
33-
34-
try {
35-
const candidates = [
36-
{ address: "ARDPkhymCbfdan375FCgPnBJQvUfHeb7nHVdBfwWSxrp", tree: "ARDPkhymCbfdan375FCgPnBJQvUfHeb7nHVdBfwWSxrp" },
37-
];
38-
39-
const { value } = await helius.zk.getMultipleNewAddressProofsV2(candidates);
40-
41-
value.forEach((p) =>
42-
console.log(
43-
p.address,
44-
"nextIndex→",
45-
p.nextIndex,
46-
"isFree→",
47-
p.proof.length === 0,
48-
),
49-
);
50-
} catch (error) {
51-
console.error("Error:", error);
52-
}
53-
})();

tsconfig.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"target": "ES2020",
44
"module": "esnext",
55
"moduleResolution": "bundler",
6+
"rootDir": "./src",
67
"outDir": "./dist",
78
"declaration": true,
89
"declarationMap": true,

0 commit comments

Comments
 (0)