Skip to content

Commit

Permalink
docs: add version, docs, and fix
Browse files Browse the repository at this point in the history
  • Loading branch information
jurevans committed Oct 3, 2024
1 parent 1d4f580 commit ccebd57
Show file tree
Hide file tree
Showing 12 changed files with 168 additions and 123 deletions.
7 changes: 1 addition & 6 deletions apps/namadillo/src/hooks/useSdk.tsx
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
<<<<<<< HEAD
import initSdk from "@heliax/namada-sdk/inline-init";
import { getSdk, Sdk } from "@heliax/namada-sdk/web";
import { QueryStatus, useQuery } from "@tanstack/react-query";
=======
import initSdk from "@heliaxdev/namada-sdk/inline-init";
import { getSdk, Sdk } from "@heliaxdev/namada-sdk/web";
>>>>>>> e6808085 (feat: update package name, regen sdk docs)
import { QueryStatus, useQuery } from "@tanstack/react-query";
import { nativeTokenAddressAtom } from "atoms/chain";
import { maspIndexerUrlAtom, rpcUrlAtom } from "atoms/settings";
import { getDefaultStore, useAtomValue } from "jotai";
Expand Down
14 changes: 7 additions & 7 deletions packages/sdk/docs/classes/Crypto.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Class Crypto handles AES encryption tasks

#### Defined in

[sdk/src/crypto/crypto.ts:20](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/crypto/crypto.ts#L20)
[sdk/src/crypto/crypto.ts:20](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/crypto/crypto.ts#L20)

## Properties

Expand All @@ -52,7 +52,7 @@ WebAssembly Memory for crypto

#### Defined in

[sdk/src/crypto/crypto.ts:20](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/crypto/crypto.ts#L20)
[sdk/src/crypto/crypto.ts:20](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/crypto/crypto.ts#L20)

## Methods

Expand All @@ -75,7 +75,7 @@ decrypted text

#### Defined in

[sdk/src/crypto/crypto.ts:115](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/crypto/crypto.ts#L115)
[sdk/src/crypto/crypto.ts:115](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/crypto/crypto.ts#L115)

___

Expand All @@ -100,7 +100,7 @@ crypto record

#### Defined in

[sdk/src/crypto/crypto.ts:61](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/crypto/crypto.ts#L61)
[sdk/src/crypto/crypto.ts:61](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/crypto/crypto.ts#L61)

___

Expand All @@ -126,7 +126,7 @@ array of encrypted bytes

#### Defined in

[sdk/src/crypto/crypto.ts:98](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/crypto/crypto.ts#L98)
[sdk/src/crypto/crypto.ts:98](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/crypto/crypto.ts#L98)

___

Expand All @@ -153,7 +153,7 @@ crypto record used for storage

#### Defined in

[sdk/src/crypto/crypto.ts:30](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/crypto/crypto.ts#L30)
[sdk/src/crypto/crypto.ts:30](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/crypto/crypto.ts#L30)

___

Expand All @@ -178,4 +178,4 @@ encryption parameters

#### Defined in

[sdk/src/crypto/crypto.ts:73](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/crypto/crypto.ts#L73)
[sdk/src/crypto/crypto.ts:73](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/crypto/crypto.ts#L73)
18 changes: 9 additions & 9 deletions packages/sdk/docs/classes/Ledger.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Functionality for interacting with NamadaApp for Ledger Hardware Wallets

#### Defined in

[sdk/src/ledger.ts:53](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/ledger.ts#L53)
[sdk/src/ledger.ts:53](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/ledger.ts#L53)

## Properties

Expand All @@ -54,7 +54,7 @@ Inititalized NamadaApp class from Zondax package

#### Defined in

[sdk/src/ledger.ts:53](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/ledger.ts#L53)
[sdk/src/ledger.ts:53](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/ledger.ts#L53)

## Methods

Expand All @@ -75,7 +75,7 @@ void

#### Defined in

[sdk/src/ledger.ts:174](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/ledger.ts#L174)
[sdk/src/ledger.ts:174](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/ledger.ts#L174)

___

Expand All @@ -102,7 +102,7 @@ Address and public key

#### Defined in

[sdk/src/ledger.ts:96](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/ledger.ts#L96)
[sdk/src/ledger.ts:96](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/ledger.ts#L96)

___

Expand All @@ -123,7 +123,7 @@ Error message if error is found

#### Defined in

[sdk/src/ledger.ts:157](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/ledger.ts#L157)
[sdk/src/ledger.ts:157](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/ledger.ts#L157)

___

Expand All @@ -150,7 +150,7 @@ Address and public key

#### Defined in

[sdk/src/ledger.ts:116](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/ledger.ts#L116)
[sdk/src/ledger.ts:116](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/ledger.ts#L116)

___

Expand Down Expand Up @@ -178,7 +178,7 @@ Response signature

#### Defined in

[sdk/src/ledger.ts:142](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/ledger.ts#L142)
[sdk/src/ledger.ts:142](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/ledger.ts#L142)

___

Expand All @@ -199,7 +199,7 @@ Version and info of NamadaApp

#### Defined in

[sdk/src/ledger.ts:79](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/ledger.ts#L79)
[sdk/src/ledger.ts:79](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/ledger.ts#L79)

___

Expand All @@ -225,4 +225,4 @@ Ledger class instance

#### Defined in

[sdk/src/ledger.ts:61](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/ledger.ts#L61)
[sdk/src/ledger.ts:61](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/ledger.ts#L61)
16 changes: 8 additions & 8 deletions packages/sdk/docs/classes/Masp.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Class representing utilities related to MASP

#### Defined in

[sdk/src/masp.ts:10](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/masp.ts#L10)
[sdk/src/masp.ts:10](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/masp.ts#L10)

## Properties

Expand All @@ -53,7 +53,7 @@ Instance of Sdk struct from wasm lib

#### Defined in

[sdk/src/masp.ts:10](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/masp.ts#L10)
[sdk/src/masp.ts:10](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/masp.ts#L10)

## Methods

Expand All @@ -80,7 +80,7 @@ void

#### Defined in

[sdk/src/masp.ts:70](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/masp.ts#L70)
[sdk/src/masp.ts:70](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/masp.ts#L70)

___

Expand All @@ -107,7 +107,7 @@ void

#### Defined in

[sdk/src/masp.ts:48](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/masp.ts#L48)
[sdk/src/masp.ts:48](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/masp.ts#L48)

___

Expand All @@ -134,7 +134,7 @@ void

#### Defined in

[sdk/src/masp.ts:59](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/masp.ts#L59)
[sdk/src/masp.ts:59](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/masp.ts#L59)

___

Expand All @@ -160,7 +160,7 @@ void

#### Defined in

[sdk/src/masp.ts:27](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/masp.ts#L27)
[sdk/src/masp.ts:27](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/masp.ts#L27)

___

Expand All @@ -180,7 +180,7 @@ True if MASP parameters are loaded

#### Defined in

[sdk/src/masp.ts:17](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/masp.ts#L17)
[sdk/src/masp.ts:17](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/masp.ts#L17)

___

Expand All @@ -206,4 +206,4 @@ void

#### Defined in

[sdk/src/masp.ts:37](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/masp.ts#L37)
[sdk/src/masp.ts:37](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/masp.ts#L37)
10 changes: 5 additions & 5 deletions packages/sdk/docs/classes/Mnemonic.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Class for accessing mnemonic functionality from wasm

#### Defined in

[sdk/src/mnemonic.ts:18](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/mnemonic.ts#L18)
[sdk/src/mnemonic.ts:18](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/mnemonic.ts#L18)

## Properties

Expand All @@ -50,7 +50,7 @@ Memory accessor for crypto lib

#### Defined in

[sdk/src/mnemonic.ts:18](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/mnemonic.ts#L18)
[sdk/src/mnemonic.ts:18](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/mnemonic.ts#L18)

## Methods

Expand All @@ -76,7 +76,7 @@ Promise that resolves to array of words

#### Defined in

[sdk/src/mnemonic.ts:26](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/mnemonic.ts#L26)
[sdk/src/mnemonic.ts:26](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/mnemonic.ts#L26)

___

Expand All @@ -101,7 +101,7 @@ Seed bytes

#### Defined in

[sdk/src/mnemonic.ts:44](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/mnemonic.ts#L44)
[sdk/src/mnemonic.ts:44](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/mnemonic.ts#L44)

___

Expand Down Expand Up @@ -131,4 +131,4 @@ Object with validation result and error message if invalid

#### Defined in

[sdk/src/mnemonic.ts:62](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/mnemonic.ts#L62)
[sdk/src/mnemonic.ts:62](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/mnemonic.ts#L62)
Loading

0 comments on commit ccebd57

Please sign in to comment.