Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/lib/classes/lumclient.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ ___

### queryClient

• `Readonly` **queryClient**: `QueryClient` & `AuthExtension` & `AuthzExtension` & `BankExtension` & `BeamExtension` & `DistributionExtension` & `GovExtension` & `IbcExtension` & `MintExtension` & `StakingExtension` & `SlashingExtension` & `FeegrantExtension`
• `Readonly` **queryClient**: `QueryClient` & `AuthExtension` & `AuthzExtension` & `BankExtension` & `BeamExtension` & `DistributionExtension` & `GovExtension` & `IbcExtension` & `MintExtension` & `StakingExtension` & `SlashingExtension` & `FeegrantExtension` & `AirdropExtension`

___

Expand Down
8 changes: 4 additions & 4 deletions docs/lib/classes/lumpaperwallet.md
Original file line number Diff line number Diff line change
Expand Up @@ -233,10 +233,10 @@ Change the wallet to use

#### Parameters

| Name | Type |
| :------ | :------ |
| `hdPath` | `string` |
| `addressPrefix` | `string` |
| Name | Type | Default value |
| :------ | :------ | :------ |
| `hdPath` | `string` | `undefined` |
| `addressPrefix` | `string` | `LumConstants.LumBech32PrefixAccAddr` |

#### Returns

Expand Down
40 changes: 20 additions & 20 deletions docs/lib/classes/lumwalletfactory.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ Create a LumWallet instance based on a keystore

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `keystore` | `string` \| [`KeyStore`](../interfaces/LumUtils.KeyStore.md) | keystore used to decypher the private key |
| `password` | `string` | keystore password |
| `addressPrefix` | `string` | prefix to use to derive the address from the public key (ex: lum) |
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `keystore` | `string` \| [`KeyStore`](../interfaces/LumUtils.KeyStore.md) | `undefined` | keystore used to decypher the private key |
| `password` | `string` | `undefined` | keystore password |
| `addressPrefix` | `string` | `LumConstants.LumBech32PrefixAccAddr` | prefix to use to derive the address from the public key (ex: lum) |

#### Returns

Expand All @@ -50,11 +50,11 @@ Create a LumWallet instance based on a ledger transport

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `transport` | `default` | Ledger transport to use (https://github.com/LedgerHQ/ledgerjs) |
| `hdPath` | `string` | BIP44 derivation path |
| `addressPrefix` | `string` | prefix to use to derive the address from the public key (ex: lum) |
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `transport` | `default` | `undefined` | Ledger transport to use (https://github.com/LedgerHQ/ledgerjs) |
| `hdPath` | `string` | `undefined` | BIP44 derivation path |
| `addressPrefix` | `string` | `LumConstants.LumBech32PrefixAccAddr` | prefix to use to derive the address from the public key (ex: lum) |

#### Returns

Expand All @@ -70,11 +70,11 @@ Create a LumWallet instance based on a mnemonic and a derivation path

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `mnemonic` | `string` | mnemonic used to derive the private key |
| `hdPath` | `string` | BIP44 derivation path |
| `addressPrefix` | `string` | prefix to use to derive the address from the public key (ex: lum) |
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `mnemonic` | `string` | `undefined` | mnemonic used to derive the private key |
| `hdPath` | `string` | `undefined` | BIP44 derivation path |
| `addressPrefix` | `string` | `LumConstants.LumBech32PrefixAccAddr` | prefix to use to derive the address from the public key (ex: lum) |

#### Returns

Expand All @@ -92,7 +92,7 @@ Create a LumWallet instance based on an OfflineDirectSigner instance compatible

| Name | Type | Description |
| :------ | :------ | :------ |
| `offlineSigner` | `OfflineDirectSigner` | OfflineDirectSigner instance compatible with Comsjs based implementations |
| `offlineSigner` | `OfflineSigner` | OfflineDirectSigner instance compatible with Comsjs based implementations |

#### Returns

Expand All @@ -108,10 +108,10 @@ Create a LumWallet instance based on a private key (secp256k1)

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `privateKey` | `Uint8Array` | wallet private key (secp256k1) |
| `addressPrefix` | `string` | prefix to use to derive the address from the public key (ex: lum) |
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `privateKey` | `Uint8Array` | `undefined` | wallet private key (secp256k1) |
| `addressPrefix` | `string` | `LumConstants.LumBech32PrefixAccAddr` | prefix to use to derive the address from the public key (ex: lum) |

#### Returns

Expand Down
42 changes: 42 additions & 0 deletions docs/lib/interfaces/lumtypes.account.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,48 @@

### Properties

- [\_baseVestingAccount](LumTypes.Account.md#_basevestingaccount)
- [\_continuousVestingAccount](LumTypes.Account.md#_continuousvestingaccount)
- [\_delayedVestingAccount](LumTypes.Account.md#_delayedvestingaccount)
- [\_moduleAccount](LumTypes.Account.md#_moduleaccount)
- [\_periodicVestingAccount](LumTypes.Account.md#_periodicvestingaccount)
- [accountNumber](LumTypes.Account.md#accountnumber)
- [address](LumTypes.Account.md#address)
- [pubkey](LumTypes.Account.md#pubkey)
- [sequence](LumTypes.Account.md#sequence)

## Properties

### \_baseVestingAccount

• `Optional` `Readonly` **\_baseVestingAccount**: `BaseVestingAccount`

___

### \_continuousVestingAccount

• `Optional` `Readonly` **\_continuousVestingAccount**: `ContinuousVestingAccount`

___

### \_delayedVestingAccount

• `Optional` `Readonly` **\_delayedVestingAccount**: `DelayedVestingAccount`

___

### \_moduleAccount

• `Optional` `Readonly` **\_moduleAccount**: `ModuleAccount`

___

### \_periodicVestingAccount

• `Optional` `Readonly` **\_periodicVestingAccount**: `PeriodicVestingAccount`

___

### accountNumber

• `Readonly` **accountNumber**: `number`
Expand All @@ -24,6 +60,12 @@ ___

___

### pubkey

• `Readonly` **pubkey**: ``null`` \| `Pubkey`

___

### sequence

• `Readonly` **sequence**: `number`
2 changes: 1 addition & 1 deletion docs/lib/interfaces/lumtypes.log.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

- [events](LumTypes.Log.md#events)
- [log](LumTypes.Log.md#log)
- [msg_index](LumTypes.Log.md#msg_index)
- [msg\_index](LumTypes.Log.md#msg_index)

## Properties

Expand Down
30 changes: 29 additions & 1 deletion docs/lib/modules/lummessages.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
- [MsgBeginRedelegateUrl](LumMessages.md#msgbeginredelegateurl)
- [MsgClaimBeamUrl](LumMessages.md#msgclaimbeamurl)
- [MsgCreateValidatorUrl](LumMessages.md#msgcreatevalidatorurl)
- [MsgCreateVestingAccountUrl](LumMessages.md#msgcreatevestingaccounturl)
- [MsgDelegateUrl](LumMessages.md#msgdelegateurl)
- [MsgDepositUrl](LumMessages.md#msgdepositurl)
- [MsgEditValidatorUrl](LumMessages.md#msgeditvalidatorurl)
Expand All @@ -37,6 +38,7 @@
- [BuildMsgBeginRedelegate](LumMessages.md#buildmsgbeginredelegate)
- [BuildMsgClaimBeam](LumMessages.md#buildmsgclaimbeam)
- [BuildMsgCreateValidator](LumMessages.md#buildmsgcreatevalidator)
- [BuildMsgCreateVestingAccount](LumMessages.md#buildmsgcreatevestingaccount)
- [BuildMsgDelegate](LumMessages.md#buildmsgdelegate)
- [BuildMsgDeposit](LumMessages.md#buildmsgdeposit)
- [BuildMsgEditValidator](LumMessages.md#buildmsgeditvalidator)
Expand Down Expand Up @@ -78,6 +80,12 @@ ___

___

### MsgCreateVestingAccountUrl

• **MsgCreateVestingAccountUrl**: ``"/cosmos.vesting.v1beta1.MsgCreateVestingAccount"``

___

### MsgDelegateUrl

• **MsgDelegateUrl**: ``"/cosmos.staking.v1beta1.MsgDelegate"``
Expand Down Expand Up @@ -194,7 +202,7 @@ ___

### MsgWithdrawValidatorCommissionUrl

• **MsgWithdrawValidatorCommissionUrl**: ``"/cosmos.bank.v1beta1.MsgSend"``
• **MsgWithdrawValidatorCommissionUrl**: ``"/cosmos.distribution.v1beta1.MsgWithdrawValidatorCommission"``

## Functions

Expand Down Expand Up @@ -257,6 +265,26 @@ ___

___

### BuildMsgCreateVestingAccount

▸ `Const` **BuildMsgCreateVestingAccount**(`fromAddress`, `toAddress`, `amount`, `endTime`, `delayed`): [`Message`](../interfaces/LumMessages.Message.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `fromAddress` | `string` |
| `toAddress` | `string` |
| `amount` | [`Coin`](../interfaces/LumTypes.Coin.md)[] |
| `endTime` | `Long` |
| `delayed` | `boolean` |

#### Returns

[`Message`](../interfaces/LumMessages.Message.md)

___

### BuildMsgDelegate

▸ `Const` **BuildMsgDelegate**(`delegatorAddress`, `validatorAddress`, `amount?`): [`Message`](../interfaces/LumMessages.Message.md)
Expand Down
65 changes: 57 additions & 8 deletions docs/lib/modules/lumutils.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@

### Functions

- [accountFromAny](LumUtils.md#accountfromany)
- [broadcastTxCommitSuccess](LumUtils.md#broadcasttxcommitsuccess)
- [broadcastTxSyncSuccess](LumUtils.md#broadcasttxsyncsuccess)
- [convertUnit](LumUtils.md#convertunit)
- [estimatedVesting](LumUtils.md#estimatedvesting)
- [generateAuthInfoBytes](LumUtils.md#generateauthinfobytes)
- [generateKeyStore](LumUtils.md#generatekeystore)
- [generateMnemonic](LumUtils.md#generatemnemonic)
Expand Down Expand Up @@ -47,6 +49,22 @@

## Functions

### accountFromAny

▸ `Const` **accountFromAny**(`input`): [`Account`](../interfaces/LumTypes.Account.md)

#### Parameters

| Name | Type |
| :------ | :------ |
| `input` | `Any` |

#### Returns

[`Account`](../interfaces/LumTypes.Account.md)

___

### broadcastTxCommitSuccess

▸ `Const` **broadcastTxCommitSuccess**(`response`): `boolean`
Expand Down Expand Up @@ -108,6 +126,37 @@ the amount converted

___

### estimatedVesting

▸ `Const` **estimatedVesting**(`account`, `t?`, `denom?`): `Object`

#### Parameters

| Name | Type | Default value |
| :------ | :------ | :------ |
| `account` | [`Account`](../interfaces/LumTypes.Account.md) | `undefined` |
| `t?` | `Date` | `undefined` |
| `denom` | `string` | `LumConstants.MicroLumDenom` |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `endsAt` | `Date` |
| `lockedBankCoins` | [`Coin`](../interfaces/LumTypes.Coin.md) |
| `lockedCoins` | [`Coin`](../interfaces/LumTypes.Coin.md) |
| `lockedDelegatedCoins` | [`Coin`](../interfaces/LumTypes.Coin.md) |
| `lockedPercentage` | `number` |
| `startsAt` | `Date` |
| `time` | `Date` |
| `totalCoins` | [`Coin`](../interfaces/LumTypes.Coin.md) |
| `unlockedCoins` | [`Coin`](../interfaces/LumTypes.Coin.md) |
| `unlockedPercentage` | `number` |

___

### generateAuthInfoBytes

▸ `Const` **generateAuthInfoBytes**(`docSigners`, `fee`, `signMode`): `Uint8Array`
Expand Down Expand Up @@ -263,10 +312,10 @@ Derives a bech32 wallet address from a public key (secp256k1)

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `publicKey` | `Uint8Array` | public key to derive the address from |
| `prefix` | `string` | address prefix to use (ex: lum) |
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `publicKey` | `Uint8Array` | `undefined` | public key to derive the address from |
| `prefix` | `string` | `LumBech32PrefixAccAddr` | address prefix to use (ex: lum) |

#### Returns

Expand Down Expand Up @@ -377,10 +426,10 @@ Verify that a wallet address is valid

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `address` | `string` | address to check |
| `prefix` | `undefined` \| `string` | prefix to check (will not be checked if not provided) |
| Name | Type | Default value | Description |
| :------ | :------ | :------ | :------ |
| `address` | `string` | `undefined` | address to check |
| `prefix` | `undefined` \| `string` | `LumBech32PrefixAccAddr` | prefix to check (will not be checked if not provided) |

#### Returns

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@lum-network/sdk-javascript",
"version": "0.7.1",
"version": "0.7.2",
"license": "Apache-2.0",
"description": "Javascript SDK library for NodeJS and Web browsers to interact with the Lum Network.",
"homepage": "https://github.com/lum-network/sdk-javascript#readme",
Expand Down
Loading