Skip to content

Commit

Permalink
add script for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
codenamejason committed Dec 6, 2023
1 parent 7a58017 commit b8d89f1
Show file tree
Hide file tree
Showing 7 changed files with 36 additions and 12 deletions.
13 changes: 13 additions & 0 deletions dist/Client/Client.d.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,15 @@
import { Chain, PublicClient, Transport } from "viem";
/**
*
* Returns a PublicClient instance that can be used to interact with the Allo v2 contracts.
*
* @remarks
* This is a wrapper around the viem PublicClient class that sets the correct chain ID and transport.
*
* @param chain - The chain ID to connect to (this is a Chain type from viem)
* @param rpc - The url of the RPC endpoint
* @returns - A PublicClient instance
*
* @beta
*/
export declare const create: (chain: Chain, rpc?: string) => PublicClient<Transport, Chain>;
13 changes: 13 additions & 0 deletions dist/Client/Client.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,19 @@
Object.defineProperty(exports, "__esModule", { value: true });
exports.create = void 0;
const viem_1 = require("viem");
/**
*
* Returns a PublicClient instance that can be used to interact with the Allo v2 contracts.
*
* @remarks
* This is a wrapper around the viem PublicClient class that sets the correct chain ID and transport.
*
* @param chain - The chain ID to connect to (this is a Chain type from viem)
* @param rpc - The url of the RPC endpoint
* @returns - A PublicClient instance
*
* @beta
*/
const create = (chain, rpc) => {
const client = (0, viem_1.createPublicClient)({
chain: chain,
Expand Down
3 changes: 0 additions & 3 deletions dist/__tests__/utils/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
Object.defineProperty(exports, "__esModule", { value: true });
exports.NATIVE = exports.makeBytes32 = exports.makeAddress = void 0;
const viem_1 = require("viem");
// import { Profile } from "../../Registry/types";
const makeAddress = (input) => {
return (0, viem_1.keccak256)((0, viem_1.toHex)(input)).slice(0, 42);
};
Expand All @@ -15,5 +14,3 @@ const NATIVE = () => {
return "0xEeeeeEeeeEeEeeEeEeEeeEEEeeeeEeeeeeeeEEeE";
};
exports.NATIVE = NATIVE;
// export const createMockProfile = () => {
// const profile:
6 changes: 3 additions & 3 deletions docs/classes/Allo.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/classes/MicroGrantsStrategy.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/classes/Registry.html

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"types": "dist/index.d.ts",
"license": "MIT",
"scripts": {
"docs": "typedoc --out docs src",
"test": "jest --no-cache",
"test:dev": "jest --watch --no-cache",
"build": "tsc",
Expand Down

0 comments on commit b8d89f1

Please sign in to comment.