From 69a829bd34e6dc3b389dc4673ed083c411e38c42 Mon Sep 17 00:00:00 2001 From: "Justin R. Evans" Date: Thu, 3 Oct 2024 11:05:06 -0400 Subject: [PATCH] docs: add version, docs, and fix --- apps/namadillo/src/hooks/useSdk.tsx | 7 +-- packages/sdk/docs/classes/Crypto.md | 14 ++--- packages/sdk/docs/classes/Ledger.md | 18 +++---- packages/sdk/docs/classes/Masp.md | 16 +++--- packages/sdk/docs/classes/Mnemonic.md | 10 ++-- packages/sdk/docs/classes/Rpc.md | 34 ++++++------ packages/sdk/docs/classes/Sdk.md | 78 +++++++++++++++++++-------- packages/sdk/docs/classes/Signing.md | 10 ++-- packages/sdk/docs/classes/Tx.md | 40 +++++++------- packages/sdk/docs/enums/KdfType.md | 4 +- packages/sdk/docs/modules.md | 44 +++++++-------- packages/sdk/src/sdk.ts | 15 ++++++ 12 files changed, 167 insertions(+), 123 deletions(-) diff --git a/apps/namadillo/src/hooks/useSdk.tsx b/apps/namadillo/src/hooks/useSdk.tsx index d53a58226..099566e36 100644 --- a/apps/namadillo/src/hooks/useSdk.tsx +++ b/apps/namadillo/src/hooks/useSdk.tsx @@ -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"; diff --git a/packages/sdk/docs/classes/Crypto.md b/packages/sdk/docs/classes/Crypto.md index 17bfbf55b..2bc1c6891 100644 --- a/packages/sdk/docs/classes/Crypto.md +++ b/packages/sdk/docs/classes/Crypto.md @@ -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 @@ -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 @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) diff --git a/packages/sdk/docs/classes/Ledger.md b/packages/sdk/docs/classes/Ledger.md index 859ed7b73..72864fb59 100644 --- a/packages/sdk/docs/classes/Ledger.md +++ b/packages/sdk/docs/classes/Ledger.md @@ -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 @@ -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 @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) diff --git a/packages/sdk/docs/classes/Masp.md b/packages/sdk/docs/classes/Masp.md index a430a73b2..a84f2908b 100644 --- a/packages/sdk/docs/classes/Masp.md +++ b/packages/sdk/docs/classes/Masp.md @@ -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 @@ -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 @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) ___ @@ -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) diff --git a/packages/sdk/docs/classes/Mnemonic.md b/packages/sdk/docs/classes/Mnemonic.md index c8feb9ac1..b41a89a2a 100644 --- a/packages/sdk/docs/classes/Mnemonic.md +++ b/packages/sdk/docs/classes/Mnemonic.md @@ -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 @@ -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 @@ -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) ___ @@ -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) ___ @@ -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) diff --git a/packages/sdk/docs/classes/Rpc.md b/packages/sdk/docs/classes/Rpc.md index cfae805ab..f49c87afd 100644 --- a/packages/sdk/docs/classes/Rpc.md +++ b/packages/sdk/docs/classes/Rpc.md @@ -51,7 +51,7 @@ API for executing RPC requests with Namada #### Defined in -[sdk/src/rpc/rpc.ts:36](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/rpc.ts#L36) +[sdk/src/rpc/rpc.ts:36](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/rpc.ts#L36) ## Properties @@ -63,7 +63,7 @@ Instance of Query struct from wasm lib #### Defined in -[sdk/src/rpc/rpc.ts:38](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/rpc.ts#L38) +[sdk/src/rpc/rpc.ts:38](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/rpc.ts#L38) ___ @@ -75,7 +75,7 @@ Instance of Sdk struct from wasm lib #### Defined in -[sdk/src/rpc/rpc.ts:37](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/rpc.ts#L37) +[sdk/src/rpc/rpc.ts:37](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/rpc.ts#L37) ## Methods @@ -102,7 +102,7 @@ TxResponseProps object #### Defined in -[sdk/src/rpc/rpc.ts:223](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/rpc.ts#L223) +[sdk/src/rpc/rpc.ts:223](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/rpc.ts#L223) ___ @@ -122,7 +122,7 @@ Array of all validator addresses #### Defined in -[sdk/src/rpc/rpc.ts:78](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/rpc.ts#L78) +[sdk/src/rpc/rpc.ts:78](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/rpc.ts#L78) ___ @@ -149,7 +149,7 @@ Query balances from chain #### Defined in -[sdk/src/rpc/rpc.ts:48](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/rpc.ts#L48) +[sdk/src/rpc/rpc.ts:48](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/rpc.ts#L48) ___ @@ -169,7 +169,7 @@ Object #### Defined in -[sdk/src/rpc/rpc.ts:203](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/rpc.ts#L203) +[sdk/src/rpc/rpc.ts:203](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/rpc.ts#L203) ___ @@ -195,7 +195,7 @@ Promise resolving to delegators votes #### Defined in -[sdk/src/rpc/rpc.ts:102](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/rpc.ts#L102) +[sdk/src/rpc/rpc.ts:102](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/rpc.ts#L102) ___ @@ -215,7 +215,7 @@ Query gas costs #### Defined in -[sdk/src/rpc/rpc.ts:194](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/rpc.ts#L194) +[sdk/src/rpc/rpc.ts:194](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/rpc.ts#L194) ___ @@ -235,7 +235,7 @@ Address of native token #### Defined in -[sdk/src/rpc/rpc.ts:57](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/rpc.ts#L57) +[sdk/src/rpc/rpc.ts:57](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/rpc.ts#L57) ___ @@ -262,7 +262,7 @@ String of public key if found #### Defined in -[sdk/src/rpc/rpc.ts:68](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/rpc.ts#L68) +[sdk/src/rpc/rpc.ts:68](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/rpc.ts#L68) ___ @@ -288,7 +288,7 @@ Promise resolving to pending ethereum transfers #### Defined in -[sdk/src/rpc/rpc.ts:185](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/rpc.ts#L185) +[sdk/src/rpc/rpc.ts:185](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/rpc.ts#L185) ___ @@ -314,7 +314,7 @@ Promise resolving to staking positions #### Defined in -[sdk/src/rpc/rpc.ts:139](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/rpc.ts#L139) +[sdk/src/rpc/rpc.ts:139](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/rpc.ts#L139) ___ @@ -340,7 +340,7 @@ Promise resolving to staking totals #### Defined in -[sdk/src/rpc/rpc.ts:112](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/rpc.ts#L112) +[sdk/src/rpc/rpc.ts:112](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/rpc.ts#L112) ___ @@ -364,7 +364,7 @@ Total bonds amount #### Defined in -[sdk/src/rpc/rpc.ts:175](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/rpc.ts#L175) +[sdk/src/rpc/rpc.ts:175](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/rpc.ts#L175) ___ @@ -391,7 +391,7 @@ Promise resolving to total delegations #### Defined in -[sdk/src/rpc/rpc.ts:89](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/rpc.ts#L89) +[sdk/src/rpc/rpc.ts:89](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/rpc.ts#L89) ___ @@ -415,4 +415,4 @@ Sync the shielded context #### Defined in -[sdk/src/rpc/rpc.ts:241](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/rpc.ts#L241) +[sdk/src/rpc/rpc.ts:241](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/rpc.ts#L241) diff --git a/packages/sdk/docs/classes/Sdk.md b/packages/sdk/docs/classes/Sdk.md index deb1b9a56..6bed6473e 100644 --- a/packages/sdk/docs/classes/Sdk.md +++ b/packages/sdk/docs/classes/Sdk.md @@ -27,6 +27,7 @@ API for interacting with Namada SDK - [rpc](Sdk.md#rpc) - [signing](Sdk.md#signing) - [tx](Sdk.md#tx) +- [version](Sdk.md#version) ### Methods @@ -37,6 +38,7 @@ API for interacting with Namada SDK - [getRpc](Sdk.md#getrpc) - [getSigning](Sdk.md#getsigning) - [getTx](Sdk.md#gettx) +- [getVersion](Sdk.md#getversion) - [initLedger](Sdk.md#initledger) - [updateNetwork](Sdk.md#updatenetwork) @@ -62,7 +64,7 @@ API for interacting with Namada SDK #### Defined in -[sdk/src/sdk.ts:23](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L23) +[sdk/src/sdk.ts:24](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L24) ## Properties @@ -74,7 +76,7 @@ Memory accessor for crypto lib #### Defined in -[sdk/src/sdk.ts:26](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L26) +[sdk/src/sdk.ts:27](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L27) ___ @@ -86,7 +88,7 @@ Address of chain's native token #### Defined in -[sdk/src/sdk.ts:28](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L28) +[sdk/src/sdk.ts:29](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L29) ___ @@ -98,7 +100,7 @@ Instance of Query struct from wasm lib #### Defined in -[sdk/src/sdk.ts:25](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L25) +[sdk/src/sdk.ts:26](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L26) ___ @@ -110,7 +112,7 @@ Instance of Sdk struct from wasm lib #### Defined in -[sdk/src/sdk.ts:24](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L24) +[sdk/src/sdk.ts:25](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L25) ___ @@ -122,7 +124,7 @@ RPC url #### Defined in -[sdk/src/sdk.ts:27](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L27) +[sdk/src/sdk.ts:28](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L28) ## Accessors @@ -140,7 +142,7 @@ Utilities for encrypting and decrypting data #### Defined in -[sdk/src/sdk.ts:166](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L166) +[sdk/src/sdk.ts:174](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L174) ___ @@ -158,7 +160,7 @@ key-related functionality #### Defined in -[sdk/src/sdk.ts:142](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L142) +[sdk/src/sdk.ts:150](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L150) ___ @@ -176,7 +178,7 @@ Masp utilities for handling params #### Defined in -[sdk/src/sdk.ts:158](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L158) +[sdk/src/sdk.ts:166](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L166) ___ @@ -194,7 +196,7 @@ mnemonic-related functionality #### Defined in -[sdk/src/sdk.ts:134](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L134) +[sdk/src/sdk.ts:142](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L142) ___ @@ -212,7 +214,7 @@ rpc client #### Defined in -[sdk/src/sdk.ts:118](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L118) +[sdk/src/sdk.ts:126](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L126) ___ @@ -230,7 +232,7 @@ Non-Tx signing functionality #### Defined in -[sdk/src/sdk.ts:150](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L150) +[sdk/src/sdk.ts:158](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L158) ___ @@ -248,7 +250,23 @@ tx-related functionality #### Defined in -[sdk/src/sdk.ts:126](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L126) +[sdk/src/sdk.ts:134](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L134) + +___ + +### version + +• `get` **version**(): `string` + +Define version getter for use with destructuring assignment + +#### Returns + +`string` + +#### Defined in + +[sdk/src/sdk.ts:181](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L181) ## Methods @@ -266,7 +284,7 @@ Utilities for encrypting and decrypting data #### Defined in -[sdk/src/sdk.ts:100](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L100) +[sdk/src/sdk.ts:101](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L101) ___ @@ -284,7 +302,7 @@ key-related functionality #### Defined in -[sdk/src/sdk.ts:76](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L76) +[sdk/src/sdk.ts:77](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L77) ___ @@ -302,7 +320,7 @@ Masp utilities for handling params #### Defined in -[sdk/src/sdk.ts:92](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L92) +[sdk/src/sdk.ts:93](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L93) ___ @@ -320,7 +338,7 @@ mnemonic-related functionality #### Defined in -[sdk/src/sdk.ts:68](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L68) +[sdk/src/sdk.ts:69](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L69) ___ @@ -338,7 +356,7 @@ Namada RPC client #### Defined in -[sdk/src/sdk.ts:52](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L52) +[sdk/src/sdk.ts:53](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L53) ___ @@ -356,7 +374,7 @@ Non-Tx signing functionality #### Defined in -[sdk/src/sdk.ts:84](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L84) +[sdk/src/sdk.ts:85](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L85) ___ @@ -374,7 +392,23 @@ Tx-related functionality #### Defined in -[sdk/src/sdk.ts:60](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L60) +[sdk/src/sdk.ts:61](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L61) + +___ + +### getVersion + +▸ **getVersion**(): `string` + +Return SDK Package version + +#### Returns + +`string` + +#### Defined in + +[sdk/src/sdk.ts:118](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L118) ___ @@ -400,7 +434,7 @@ Class for interacting with NamadaApp for Ledger Hardware Wallets #### Defined in -[sdk/src/sdk.ts:110](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L110) +[sdk/src/sdk.ts:111](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L111) ___ @@ -425,4 +459,4 @@ this instance of Sdk #### Defined in -[sdk/src/sdk.ts:37](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/sdk.ts#L37) +[sdk/src/sdk.ts:38](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/sdk.ts#L38) diff --git a/packages/sdk/docs/classes/Signing.md b/packages/sdk/docs/classes/Signing.md index 87088259e..2295c41cb 100644 --- a/packages/sdk/docs/classes/Signing.md +++ b/packages/sdk/docs/classes/Signing.md @@ -40,7 +40,7 @@ Signing constructor #### Defined in -[sdk/src/signing.ts:14](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/signing.ts#L14) +[sdk/src/signing.ts:14](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/signing.ts#L14) ## Properties @@ -52,7 +52,7 @@ Instance of Sdk struct from wasm lib #### Defined in -[sdk/src/signing.ts:14](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/signing.ts#L14) +[sdk/src/signing.ts:14](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/signing.ts#L14) ## Methods @@ -78,7 +78,7 @@ signed tx bytes - Promise resolving to Uint8Array #### Defined in -[sdk/src/signing.ts:23](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/signing.ts#L23) +[sdk/src/signing.ts:23](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/signing.ts#L23) ___ @@ -103,7 +103,7 @@ hash and signature #### Defined in -[sdk/src/signing.ts:41](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/signing.ts#L41) +[sdk/src/signing.ts:41](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/signing.ts#L41) ___ @@ -129,4 +129,4 @@ void #### Defined in -[sdk/src/signing.ts:52](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/signing.ts#L52) +[sdk/src/signing.ts:52](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/signing.ts#L52) diff --git a/packages/sdk/docs/classes/Tx.md b/packages/sdk/docs/classes/Tx.md index 74210af78..32b760d95 100644 --- a/packages/sdk/docs/classes/Tx.md +++ b/packages/sdk/docs/classes/Tx.md @@ -53,7 +53,7 @@ SDK functionality related to transactions #### Defined in -[sdk/src/tx/tx.ts:55](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L55) +[sdk/src/tx/tx.ts:55](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L55) ## Properties @@ -65,7 +65,7 @@ Instance of Sdk struct from wasm lib #### Defined in -[sdk/src/tx/tx.ts:55](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L55) +[sdk/src/tx/tx.ts:55](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L55) ## Methods @@ -90,7 +90,7 @@ Append signature for transactions signed by Ledger Hardware Wallet #### Defined in -[sdk/src/tx/tx.ts:371](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L371) +[sdk/src/tx/tx.ts:371](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L371) ___ @@ -114,7 +114,7 @@ a serialized TxMsgValue type #### Defined in -[sdk/src/tx/tx.ts:354](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L354) +[sdk/src/tx/tx.ts:354](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L354) ___ @@ -141,7 +141,7 @@ promise that resolves to an TxMsgValue #### Defined in -[sdk/src/tx/tx.ts:176](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L176) +[sdk/src/tx/tx.ts:176](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L176) ___ @@ -168,7 +168,7 @@ promise that resolves to an TxMsgValue #### Defined in -[sdk/src/tx/tx.ts:333](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L333) +[sdk/src/tx/tx.ts:333](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L333) ___ @@ -195,7 +195,7 @@ promise that resolves to an TxMsgValue #### Defined in -[sdk/src/tx/tx.ts:286](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L286) +[sdk/src/tx/tx.ts:286](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L286) ___ @@ -222,7 +222,7 @@ promise that resolves to an TxMsgValue #### Defined in -[sdk/src/tx/tx.ts:263](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L263) +[sdk/src/tx/tx.ts:263](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L263) ___ @@ -249,7 +249,7 @@ promise that resolves to an TxMsgValue #### Defined in -[sdk/src/tx/tx.ts:240](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L240) +[sdk/src/tx/tx.ts:240](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L240) ___ @@ -275,7 +275,7 @@ promise that resolves to an TxMsgValue #### Defined in -[sdk/src/tx/tx.ts:163](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L163) +[sdk/src/tx/tx.ts:163](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L163) ___ @@ -302,7 +302,7 @@ promise that resolves to an TxMsgValue #### Defined in -[sdk/src/tx/tx.ts:89](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L89) +[sdk/src/tx/tx.ts:89](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L89) ___ @@ -329,7 +329,7 @@ promise that resolves to an TxMsgValue #### Defined in -[sdk/src/tx/tx.ts:114](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L114) +[sdk/src/tx/tx.ts:114](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L114) ___ @@ -356,7 +356,7 @@ promise that resolves to an TxMsgValue #### Defined in -[sdk/src/tx/tx.ts:64](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L64) +[sdk/src/tx/tx.ts:64](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L64) ___ @@ -383,7 +383,7 @@ promise that resolves to an TxMsgValue #### Defined in -[sdk/src/tx/tx.ts:197](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L197) +[sdk/src/tx/tx.ts:197](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L197) ___ @@ -410,7 +410,7 @@ promise that resolves to an TxMsgValue #### Defined in -[sdk/src/tx/tx.ts:139](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L139) +[sdk/src/tx/tx.ts:139](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L139) ___ @@ -437,7 +437,7 @@ promise that resolves to an TxMsgValue #### Defined in -[sdk/src/tx/tx.ts:309](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L309) +[sdk/src/tx/tx.ts:309](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L309) ___ @@ -464,7 +464,7 @@ promise that resolves to an TxMsgValue #### Defined in -[sdk/src/tx/tx.ts:219](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L219) +[sdk/src/tx/tx.ts:219](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L219) ___ @@ -489,7 +489,7 @@ a TxDetails object #### Defined in -[sdk/src/tx/tx.ts:424](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L424) +[sdk/src/tx/tx.ts:424](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L424) ___ @@ -513,7 +513,7 @@ Serialized WrapperTxMsgValue #### Defined in -[sdk/src/tx/tx.ts:412](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L412) +[sdk/src/tx/tx.ts:412](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L412) ___ @@ -537,4 +537,4 @@ array of inner Tx hashes #### Defined in -[sdk/src/tx/tx.ts:480](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/tx/tx.ts#L480) +[sdk/src/tx/tx.ts:480](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/tx/tx.ts#L480) diff --git a/packages/sdk/docs/enums/KdfType.md b/packages/sdk/docs/enums/KdfType.md index 049d81bf9..1dae16c71 100644 --- a/packages/sdk/docs/enums/KdfType.md +++ b/packages/sdk/docs/enums/KdfType.md @@ -17,7 +17,7 @@ #### Defined in -[sdk/src/crypto/types.ts:38](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/crypto/types.ts#L38) +[sdk/src/crypto/types.ts:38](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/crypto/types.ts#L38) ___ @@ -27,4 +27,4 @@ ___ #### Defined in -[sdk/src/crypto/types.ts:39](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/crypto/types.ts#L39) +[sdk/src/crypto/types.ts:39](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/crypto/types.ts#L39) diff --git a/packages/sdk/docs/modules.md b/packages/sdk/docs/modules.md index 641d9d4cd..6ded3aade 100644 --- a/packages/sdk/docs/modules.md +++ b/packages/sdk/docs/modules.md @@ -69,7 +69,7 @@ Address and public key type #### Defined in -[sdk/src/keys/types.ts:4](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/keys/types.ts#L4) +[sdk/src/keys/types.ts:4](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/keys/types.ts#L4) ___ @@ -86,7 +86,7 @@ ___ #### Defined in -[sdk/src/ledger.ts:16](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/ledger.ts#L16) +[sdk/src/ledger.ts:16](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/ledger.ts#L16) ___ @@ -96,7 +96,7 @@ ___ #### Defined in -[sdk/src/crypto/types.ts:23](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/crypto/types.ts#L23) +[sdk/src/crypto/types.ts:23](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/crypto/types.ts#L23) ___ @@ -109,7 +109,7 @@ Balance #### Defined in -[sdk/src/rpc/types.ts:69](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/types.ts#L69) +[sdk/src/rpc/types.ts:69](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/types.ts#L69) ___ @@ -128,7 +128,7 @@ ___ #### Defined in -[sdk/src/rpc/types.ts:27](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/types.ts#L27) +[sdk/src/rpc/types.ts:27](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/types.ts#L27) ___ @@ -156,7 +156,7 @@ ___ #### Defined in -[sdk/src/crypto/types.ts:42](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/crypto/types.ts#L42) +[sdk/src/crypto/types.ts:42](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/crypto/types.ts#L42) ___ @@ -169,7 +169,7 @@ Record #### Defined in -[sdk/src/rpc/types.ts:51](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/types.ts#L51) +[sdk/src/rpc/types.ts:51](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/types.ts#L51) ___ @@ -182,7 +182,7 @@ Record #### Defined in -[sdk/src/rpc/types.ts:57](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/types.ts#L57) +[sdk/src/rpc/types.ts:57](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/types.ts#L57) ___ @@ -201,7 +201,7 @@ ___ #### Defined in -[sdk/src/crypto/types.ts:30](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/crypto/types.ts#L30) +[sdk/src/crypto/types.ts:30](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/crypto/types.ts#L30) ___ @@ -218,7 +218,7 @@ ___ #### Defined in -[sdk/src/ledger.ts:17](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/ledger.ts#L17) +[sdk/src/ledger.ts:17](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/ledger.ts#L17) ___ @@ -238,7 +238,7 @@ Shielded keys and address #### Defined in -[sdk/src/keys/types.ts:19](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/keys/types.ts#L19) +[sdk/src/keys/types.ts:19](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/keys/types.ts#L19) ___ @@ -255,7 +255,7 @@ ___ #### Defined in -[sdk/src/rpc/types.ts:42](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/types.ts#L42) +[sdk/src/rpc/types.ts:42](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/types.ts#L42) ___ @@ -275,7 +275,7 @@ ___ #### Defined in -[sdk/src/rpc/types.ts:19](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/types.ts#L19) +[sdk/src/rpc/types.ts:19](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/types.ts#L19) ___ @@ -285,7 +285,7 @@ ___ #### Defined in -[shared/src/types.ts:3](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/shared/src/types.ts#L3) +[shared/src/types.ts:3](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/shared/src/types.ts#L3) ___ @@ -297,7 +297,7 @@ Public and private keypair with address #### Defined in -[sdk/src/keys/types.ts:12](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/keys/types.ts#L12) +[sdk/src/keys/types.ts:12](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/keys/types.ts#L12) ___ @@ -317,7 +317,7 @@ ___ #### Defined in -[sdk/src/rpc/types.ts:34](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/rpc/types.ts#L34) +[sdk/src/rpc/types.ts:34](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/rpc/types.ts#L34) ## Variables @@ -335,7 +335,7 @@ ___ #### Defined in -[sdk/src/crypto/types.ts:3](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/crypto/types.ts#L3) +[sdk/src/crypto/types.ts:3](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/crypto/types.ts#L3) ___ @@ -345,7 +345,7 @@ ___ #### Defined in -[sdk/src/ledger.ts:40](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/ledger.ts#L40) +[sdk/src/ledger.ts:40](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/ledger.ts#L40) ___ @@ -355,7 +355,7 @@ ___ #### Defined in -[shared/src/types.ts:28](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/shared/src/types.ts#L28) +[shared/src/types.ts:28](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/shared/src/types.ts#L28) ## Functions @@ -375,7 +375,7 @@ Transport object #### Defined in -[sdk/src/ledger.ts:36](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/ledger.ts#L36) +[sdk/src/ledger.ts:36](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/ledger.ts#L36) ___ @@ -395,7 +395,7 @@ Transport object #### Defined in -[sdk/src/ledger.ts:27](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/ledger.ts#L27) +[sdk/src/ledger.ts:27](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/ledger.ts#L27) ___ @@ -415,4 +415,4 @@ ___ #### Defined in -[sdk/src/keys/keys.ts:173](https://github.com/anoma/namada-interface/blob/274de167f98eee0c6109fe1c209a8a1e3e9d3690/packages/sdk/src/keys/keys.ts#L173) +[sdk/src/keys/keys.ts:173](https://github.com/anoma/namada-interface/blob/1d4f58032bec9e5a3a9d37d9972c35c7fcd31151/packages/sdk/src/keys/keys.ts#L173) diff --git a/packages/sdk/src/sdk.ts b/packages/sdk/src/sdk.ts index 00f3e877d..49d0788d5 100644 --- a/packages/sdk/src/sdk.ts +++ b/packages/sdk/src/sdk.ts @@ -1,5 +1,6 @@ import Transport from "@ledgerhq/hw-transport"; import { Query as QueryWasm, Sdk as SdkWasm } from "@namada/shared"; +import { version } from "../package.json"; import { Crypto } from "./crypto"; import { Keys } from "./keys"; import { Ledger } from "./ledger"; @@ -111,6 +112,13 @@ export class Sdk { return await Ledger.init(transport); } + /** + * Return SDK Package version + */ + getVersion(): string { + return version; + } + /** * Define rpc getter to use with destructuring assignment * @returns rpc client @@ -166,4 +174,11 @@ export class Sdk { get crypto(): Crypto { return this.getCrypto(); } + + /** + * Define version getter for use with destructuring assignment + */ + get version(): string { + return this.getVersion(); + } }