▸ getConfigurations(method: any, contentType: string, url: string, configurations?: IRequestConfiguration): IRequestConfiguration

Parameters:

Name	Type
`method`	any
`contentType`	string
`url`	string
`configurations?`	IRequestConfiguration

Returns: IRequestConfiguration

Defined in: cosmos/index.ts:135

request

▸ request(configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: cosmos/index.ts:131

JSDK / cosmos/AuthService / AuthService

Class: AuthService

cosmos/AuthService.AuthService

Constructors

constructor

Methods

getAuthAccountsAddress

Constructors

constructor

+ new AuthService(): AuthService

Returns: AuthService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: cosmos/rests/axios.ts:62

Defined in: cosmos/AuthService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: cosmos/rests/axios.ts:29

Defined in: cosmos/AuthService.ts:210

Methods

getAuthAccountsAddress

▸ StaticgetAuthAccountsAddress<Return>(parameters: { address: string }, options?: IRequestConfiguration): Promise<Return>

description Get the account information on blockchain

200 - Account information on the blockchain
500 - Server internel error

method getAuthAccountsAddress

see /auth/accounts/{address}

Type parameters:

Name	Default
`Return`	{ `type`: string ; `value`: { `account_number`: string ; `address`: string ; `coins`: Coin[] ; `public_key`: PublicKey ; `sequence`: string } }

Parameters:

Name	Type	Description
`parameters`	object
`parameters.address`	string	(in path) - Account address
`options?`	IRequestConfiguration

Returns: Promise<Return>

{Promise<{ type: string, value: { * account_number: string, * address: string, * coins: Coin[], * public_key: PublicKey, * sequence: string } }>}

Defined in: cosmos/AuthService.ts:238

JSDK / cosmos/BankService / BankService

Class: BankService

cosmos/BankService.BankService

Constructors

constructor

Properties

getConfigurations
request

Methods

getBankBalancesAddress
postBankAccountsAddressTransfers

Constructors

constructor

+ new BankService(): BankService

Returns: BankService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: cosmos/rests/axios.ts:62

Defined in: cosmos/BankService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: cosmos/rests/axios.ts:29

Defined in: cosmos/BankService.ts:210

Methods

getBankBalancesAddress

▸ StaticgetBankBalancesAddress<Return>(parameters: { address: string }, options?: IRequestConfiguration): Promise<Return>

description Get the account balances

200 - Account balances
500 - Server internal error

method getBankBalancesAddress

see /bank/balances/{address}

Type parameters:

Name	Default
`Return`	Coin[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.address`	string	(in path) - Account address in bech32 format
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/BankService.ts:268

postBankAccountsAddressTransfers

▸ StaticpostBankAccountsAddressTransfers<Return>(parameters: { account: { amount: Coin[] ; base_req: BaseReq } ; address: string }, options?: IRequestConfiguration): Promise<Return>

description Send coins from one account to another

202 - Tx was succesfully generated
400 - Invalid request
500 - Server internal error

method postBankAccountsAddressTransfers

see /bank/accounts/{address}/transfers

Type parameters:

Name	Default
`Return`	any

Parameters:

Name	Type	Description
`parameters`	object
`parameters.account`	object	-
`parameters.account.amount`	Coin[]	-
`parameters.account.base_req`	BaseReq	-
`parameters.address`	string	(in path) - Account address in bech32 format
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/BankService.ts:234

JSDK / cosmos/CurrenciesService / CurrenciesService

Class: CurrenciesService

cosmos/CurrenciesService.CurrenciesService

Constructors

constructor

Properties

getConfigurations
request

Methods

getCurrencies
getCurrenciesCurrencyDenom
getCurrenciesIssueIssueId
getCurrenciesWithdrawWithdrawId
getCurrenciesWithdraws
putCurrenciesIssue
putCurrenciesUnstake
putCurrenciesWithdraw

Constructors

constructor

+ new CurrenciesService(): CurrenciesService

Returns: CurrenciesService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: cosmos/rests/axios.ts:62

Defined in: cosmos/CurrenciesService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: cosmos/rests/axios.ts:29

Defined in: cosmos/CurrenciesService.ts:210

Methods

getCurrencies

▸ StaticgetCurrencies<Return>(options?: IRequestConfiguration): Promise<Return>

description Get all registered currencies

200 - OK
500 - Returned on server error

method getCurrencies

see /currencies

Type parameters:

Name	Default
`Return`	RestCcRespGetCurrencies

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/CurrenciesService.ts:227

getCurrenciesCurrencyDenom

▸ StaticgetCurrenciesCurrencyDenom<Return>(parameters: { denom: string }, options?: IRequestConfiguration): Promise<Return>

description Get currency

description Get currency by denom

200 - OK
500 - Returned on server error

method getCurrenciesCurrencyDenom

see /currencies/currency/{denom}

Type parameters:

Name	Default
`Return`	RestCcRespGetCurrency

Parameters:

Name	Type	Description
`parameters`	object
`parameters.denom`	string	(in path) - currency denomination symbol
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/CurrenciesService.ts:254

getCurrenciesIssueIssueId

▸ StaticgetCurrenciesIssueIssueId<Return>(parameters: { issueID: string }, options?: IRequestConfiguration): Promise<Return>

description Get currency issue

description Get currency issue by issueID

200 - OK
500 - Returned on server error

method getCurrenciesIssueIssueId

see /currencies/issue/{issueID}

Type parameters:

Name	Default
`Return`	RestCcRespGetIssue

Parameters:

Name	Type	Description
`parameters`	object
`parameters.issueID`	string	(in path) - issueID
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/CurrenciesService.ts:321

getCurrenciesWithdrawWithdrawId

▸ StaticgetCurrenciesWithdrawWithdrawId<Return>(parameters: { withdrawID: number }, options?: IRequestConfiguration): Promise<Return>

description Get currency withdraw

description Get currency withdraw by withdrawID

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getCurrenciesWithdrawWithdrawId

see /currencies/withdraw/{withdrawID}

Type parameters:

Name	Default
`Return`	RestCcRespGetWithdraw

Parameters:

Name	Type	Description
`parameters`	object
`parameters.withdrawID`	number	(in path) - withdrawID
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/CurrenciesService.ts:424

getCurrenciesWithdraws

▸ StaticgetCurrenciesWithdraws<Return>(parameters: { limit?: number ; page?: number }, options?: IRequestConfiguration): Promise<Return>

description Get currency withdraws

description Get array of Withdraw objects with pagination

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getCurrenciesWithdraws

see /currencies/withdraws

Type parameters:

Name	Default
`Return`	RestCcRespGetWithdraws

Parameters:

Name	Type	Description
`parameters`	object
`parameters.limit?`	number	(in query) - items per page (default: 100)
`parameters.page?`	number	(in query) - page number (first page: 1)
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/CurrenciesService.ts:458

putCurrenciesIssue

▸ StaticputCurrenciesIssue<Return>(parameters: { request: RestSubmitIssueReq }, options?: IRequestConfiguration): Promise<Return>

description Submit issue

description Get submit new issue multi signature message stdTx object

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method putCurrenciesIssue

see /currencies/issue

Type parameters:

Name	Default
`Return`	RestCcRespStdTx

Parameters:

Name	Type	Description
`parameters`	object
`parameters.request`	RestSubmitIssueReq	(in body) - Submit issue request
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/CurrenciesService.ts:287

putCurrenciesUnstake

▸ StaticputCurrenciesUnstake<Return>(parameters: { request: RestUnstakeReq }, options?: IRequestConfiguration): Promise<Return>

description Unstake tx

description Get new unstake multi signature message stdTx object

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method putCurrenciesUnstake

see /currencies/unstake

Type parameters:

Name	Default
`Return`	RestCcRespStdTx

Parameters:

Name	Type	Description
`parameters`	object
`parameters.request`	RestUnstakeReq	(in body) - Submit unstake request
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/CurrenciesService.ts:354

putCurrenciesWithdraw

▸ StaticputCurrenciesWithdraw<Return>(parameters: { request: RestWithdrawReq }, options?: IRequestConfiguration): Promise<Return>

description Withdraw currency

description Get withdraw currency coins from account balance stdTx object

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method putCurrenciesWithdraw

see /currencies/withdraw

Type parameters:

Name	Default
`Return`	RestCcRespStdTx

Parameters:

Name	Type	Description
`parameters`	object
`parameters.request`	RestWithdrawReq	(in body) - Withdraw request
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/CurrenciesService.ts:389

JSDK / cosmos/DistributionService / DistributionService

Class: DistributionService

cosmos/DistributionService.DistributionService

Constructors

constructor

Properties

getConfigurations
request

Methods

getDistributionCommunityPool
getDistributionDelegatorsDelegatorAddrRewards
getDistributionDelegatorsDelegatorAddrRewardsValidatorAddr
getDistributionDelegatorsDelegatorAddrWithdrawAddress
getDistributionParameters
getDistributionPoolPoolName
getDistributionValidatorExtendedValidatorAddr
getDistributionValidatorsExtended
getDistributionValidatorsValidatorAddr
getDistributionValidatorsValidatorAddrOutstandingRewards
getDistributionValidatorsValidatorAddrRewards
postDistributionDelegatorsDelegatorAddrRewards
postDistributionDelegatorsDelegatorAddrRewardsValidatorAddr
postDistributionDelegatorsDelegatorAddrWithdrawAddress
postDistributionPublicTreasuryPool
postDistributionValidatorsValidatorAddrRewards

Constructors

constructor

+ new DistributionService(): DistributionService

Returns: DistributionService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: cosmos/rests/axios.ts:62

Defined in: cosmos/DistributionService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: cosmos/rests/axios.ts:29

Defined in: cosmos/DistributionService.ts:210

Methods

getDistributionCommunityPool

▸ StaticgetDistributionCommunityPool<Return>(options?: IRequestConfiguration): Promise<Return>

description Community pool parameters

200 - OK
500 - Internal Server Error

method getDistributionCommunityPool

see /distribution/community_pool

Type parameters:

Name	Default
`Return`	Coin[]

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/DistributionService.ts:227

getDistributionDelegatorsDelegatorAddrRewards

▸ StaticgetDistributionDelegatorsDelegatorAddrRewards<Return>(parameters: { delegatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Get the total rewards balance from all delegations

description Get the sum of all the rewards earned by delegations by a single delegator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionDelegatorsDelegatorAddrRewards

see /distribution/delegators/{delegatorAddr}/rewards

Type parameters:

Name	Default
`Return`	RestQueryDelegatorRewardsResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/DistributionService.ts:255

getDistributionDelegatorsDelegatorAddrRewardsValidatorAddr

▸ StaticgetDistributionDelegatorsDelegatorAddrRewardsValidatorAddr<Return>(parameters: { delegatorAddr: string ; validatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Query a delegation reward

description Query a single delegation reward by a delegator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionDelegatorsDelegatorAddrRewardsValidatorAddr

see /distribution/delegators/{delegatorAddr}/rewards/{validatorAddr}

Type parameters:

Name	Default
`Return`	RestQueryDelegationRewardsResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`parameters.validatorAddr`	string	(in path) - Bech32 OperatorAddress of validator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/DistributionService.ts:326

getDistributionDelegatorsDelegatorAddrWithdrawAddress

▸ StaticgetDistributionDelegatorsDelegatorAddrWithdrawAddress<Return>(parameters: { delegatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Get the rewards withdrawal address

description Get the delegations' rewards withdrawal address. This is the address in which the user will receive the reward funds

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionDelegatorsDelegatorAddrWithdrawAddress

see /distribution/delegators/{delegatorAddr}/withdraw_address

Type parameters:

Name	Default
`Return`	RestQueryAddressResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/DistributionService.ts:403

getDistributionParameters

▸ StaticgetDistributionParameters<Return>(options?: IRequestConfiguration): Promise<Return>

description Fee distribution parameters

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionParameters

see /distribution/parameters

Type parameters:

Name	Default
`Return`	RestQueryParamsResp

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/DistributionService.ts:477

getDistributionPoolPoolName

▸ StaticgetDistributionPoolPoolName<Return>(parameters: { poolName: string }, options?: IRequestConfiguration): Promise<Return>

description Get the amount held in the specified pool

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionPoolPoolName

see /distribution/pool/{poolName}

Type parameters:

Name	Default
`Return`	RestQueryDecCoinsResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.poolName`	string	(in path) - PoolName: LiquidityProvidersPool, FoundationPool, PublicTreasuryPool, HARP
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/DistributionService.ts:505

getDistributionValidatorExtendedValidatorAddr

▸ StaticgetDistributionValidatorExtendedValidatorAddr<Return>(parameters: { validatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Query the extended information from a single validator

description Query the extended information from a single validator containing distribution params

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionValidatorExtendedValidatorAddr

see /distribution/validator_extended/{validatorAddr}

Type parameters:

Name	Default
`Return`	RestQueryExtendedValidatorResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.validatorAddr`	string	(in path) - Bech32 OperatorAddress of validator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/DistributionService.ts:573

getDistributionValidatorsExtended

▸ StaticgetDistributionValidatorsExtended<Return>(parameters: { limit?: string ; page?: string ; status?: string }, options?: IRequestConfiguration): Promise<Return>

description Query the extended information from multiple validators

description Query the extended information from multiple validators containing distribution params

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionValidatorsExtended

see /distribution/validators_extended

Type parameters:

Name	Default
`Return`	RestQueryExtendedValidatorsResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.limit?`	string	(in query) - The maximum number of items per page
`parameters.page?`	string	(in query) - The page number
`parameters.status?`	string	(in query) - The validator bond status. Must be either 'bonded', 'unbonded', or 'unbonding'
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/DistributionService.ts:747

getDistributionValidatorsValidatorAddr

▸ StaticgetDistributionValidatorsValidatorAddr<Return>(parameters: { validatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Validator distribution information

description Query the distribution information of a single validator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionValidatorsValidatorAddr

see /distribution/validators/{validatorAddr}

Type parameters:

Name	Default
`Return`	RestQuerySwaggerValidatorDistInfoResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.validatorAddr`	string	(in path) - Bech32 OperatorAddress of validator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/DistributionService.ts:606

getDistributionValidatorsValidatorAddrOutstandingRewards

▸ StaticgetDistributionValidatorsValidatorAddrOutstandingRewards<Return>(parameters: { validatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Fee distribution outstanding rewards of a single validator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionValidatorsValidatorAddrOutstandingRewards

see /distribution/validators/{validatorAddr}/outstanding_rewards

Type parameters:

Name	Default
`Return`	RestQueryDecCoinsResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.validatorAddr`	string	(in path) - Bech32 OperatorAddress of validator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/DistributionService.ts:639

getDistributionValidatorsValidatorAddrRewards

▸ StaticgetDistributionValidatorsValidatorAddrRewards<Return>(parameters: { validatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Commission and self-delegation rewards of a single validator

description Query the commission and self-delegation rewards of validator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionValidatorsValidatorAddrRewards

see /distribution/validators/{validatorAddr}/rewards

Type parameters:

Name	Default
`Return`	RestQueryDecCoinsResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.validatorAddr`	string	(in path) - Bech32 OperatorAddress of validator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/DistributionService.ts:675

postDistributionDelegatorsDelegatorAddrRewards

▸ StaticpostDistributionDelegatorsDelegatorAddrRewards<Return>(parameters: { delegatorAddr: string ; postRequest: RestWithdrawRewardsReq }, options?: IRequestConfiguration): Promise<Return>

description Withdraw all the delegator's delegation rewards

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method postDistributionDelegatorsDelegatorAddrRewards

see /distribution/delegators/{delegatorAddr}/rewards

Type parameters:

Name	Default
`Return`	RestTxWithdrawDelegatorReward[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`parameters.postRequest`	RestWithdrawRewardsReq	(in body) - WithdrawRewardsReq request with signed transaction
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/DistributionService.ts:289

postDistributionDelegatorsDelegatorAddrRewardsValidatorAddr

▸ StaticpostDistributionDelegatorsDelegatorAddrRewardsValidatorAddr<Return>(parameters: { delegatorAddr: string ; postRequest: RestWithdrawRewardsReq ; validatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Withdraw a delegation reward

description Withdraw a delegator's delegation reward from a single validator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method postDistributionDelegatorsDelegatorAddrRewardsValidatorAddr

see /distribution/delegators/{delegatorAddr}/rewards/{validatorAddr}

Type parameters:

Name	Default
`Return`	RestTxWithdrawDelegatorReward[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`parameters.postRequest`	RestWithdrawRewardsReq	(in body) - WithdrawRewardsReq request with signed transaction
`parameters.validatorAddr`	string	(in path) - Bech32 OperatorAddress of validator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/DistributionService.ts:364

postDistributionDelegatorsDelegatorAddrWithdrawAddress

▸ StaticpostDistributionDelegatorsDelegatorAddrWithdrawAddress<Return>(parameters: { delegatorAddr: string ; postRequest: RestSetWithdrawalAddrReq }, options?: IRequestConfiguration): Promise<Return>

description Withdraw a delegation reward

description Withdraw a delegator's delegation reward from a single validator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method postDistributionDelegatorsDelegatorAddrWithdrawAddress

see /distribution/delegators/{delegatorAddr}/withdraw_address

Type parameters:

Name	Default
`Return`	RestTxSetWithdrawAddress[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`parameters.postRequest`	RestSetWithdrawalAddrReq	(in body) - SetWithdrawalAddrReq request with signed transaction
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/DistributionService.ts:440

postDistributionPublicTreasuryPool

▸ StaticpostDistributionPublicTreasuryPool<Return>(parameters: { postRequest: RestFundPublicTreasuryPoolReq }, options?: IRequestConfiguration): Promise<Return>

description Fund the public treasury pool

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method postDistributionPublicTreasuryPool

see /distribution/public_treasury_pool

Type parameters:

Name	Default
`Return`	RestTxFundPublicTreasuryPool[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.postRequest`	RestFundPublicTreasuryPoolReq	(in body) - FundPublicTreasuryPoolReq request with signed transaction
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/DistributionService.ts:538

postDistributionValidatorsValidatorAddrRewards

▸ StaticpostDistributionValidatorsValidatorAddrRewards<Return>(parameters: { postRequest: RestWithdrawRewardsReq ; validatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Withdraw the validator's rewards

description Withdraw the validator's self-delegation and commissions rewards

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method postDistributionValidatorsValidatorAddrRewards

see /distribution/validators/{validatorAddr}/rewards

Type parameters:

Name	Default
`Return`	TypesStdTx[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.postRequest`	RestWithdrawRewardsReq	(in body) - WithdrawRewardsReq request with signed transaction
`parameters.validatorAddr`	string	(in path) - Bech32 OperatorAddress of validator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/DistributionService.ts:709

JSDK / cosmos/GovernanceService / GovernanceService

Class: GovernanceService

cosmos/GovernanceService.GovernanceService

Constructors

constructor

Properties

getConfigurations
request

Methods

getGovParametersDeposit
getGovParametersTallying
getGovParametersVoting
getGovProposals
getGovProposalsProposalId
getGovProposalsProposalIdDeposits
getGovProposalsProposalIdDepositsDepositor
getGovProposalsProposalIdProposer
getGovProposalsProposalIdTally
getGovProposalsProposalIdVotes
getGovProposalsProposalIdVotesVoter
postGovProposals
postGovProposalsParamChange
postGovProposalsProposalIdDeposits
postGovProposalsProposalIdVotes

Constructors

constructor

+ new GovernanceService(): GovernanceService

Returns: GovernanceService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: cosmos/rests/axios.ts:62

Defined in: cosmos/GovernanceService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: cosmos/rests/axios.ts:29

Defined in: cosmos/GovernanceService.ts:210

Methods

getGovParametersDeposit

▸ StaticgetGovParametersDeposit<Return>(options?: IRequestConfiguration): Promise<Return>

description Query governance deposit parameters

description Query governance deposit parameters. The max_deposit_period units are in nanoseconds.

200 - OK
400 -  is not a valid query request path
404 - Found no deposit parameters
500 - Internal Server Error

method getGovParametersDeposit

see /gov/parameters/deposit

Type parameters:

Name	Default
`Return`	{ `max_deposit_period`: string ; `min_deposit`: Coin[] }

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

{Promise<{ max_deposit_period: string, min_deposit: Coin[] }>}

Defined in: cosmos/GovernanceService.ts:233

getGovParametersTallying

▸ StaticgetGovParametersTallying<Return>(options?: IRequestConfiguration): Promise<Return>

description Query governance tally parameters

200 - OK
400 -  is not a valid query request path
404 - Found no tally parameters
500 - Internal Server Error

method getGovParametersTallying

see /gov/parameters/tallying

Type parameters:

Name	Default
`Return`	{ `governance_penalty`: string ; `threshold`: string ; `veto`: string }

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

{Promise<{ governance_penalty: string, threshold: string, veto: string }>}

Defined in: cosmos/GovernanceService.ts:266

getGovParametersVoting

▸ StaticgetGovParametersVoting<Return>(options?: IRequestConfiguration): Promise<Return>

description Query governance voting parameters

description Query governance voting parameters. The voting_period units are in nanoseconds.

200 - OK
400 -  is not a valid query request path
404 - Found no voting parameters
500 - Internal Server Error

method getGovParametersVoting

see /gov/parameters/voting

Type parameters:

Name	Default
`Return`	{ `voting_period`: string }

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

{Promise<{ voting_period: string }>}

Defined in: cosmos/GovernanceService.ts:297

getGovProposals

▸ StaticgetGovProposals<Return>(parameters: { depositor?: string ; status?: string ; voter?: string }, options?: IRequestConfiguration): Promise<Return>

description Query proposals

description Query proposals information with parameters

200 - OK
400 - Invalid query parameters
500 - Internal Server Error

method getGovProposals

see /gov/proposals

Type parameters:

Name	Default
`Return`	TextProposal[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.depositor?`	string	(in query) - depositor address
`parameters.status?`	string	(in query) - proposal status, valid values can be '"deposit_period"', '"voting_period"', '"passed"', '"rejected"'
`parameters.voter?`	string	(in query) - voter address
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/GovernanceService.ts:327

getGovProposalsProposalId

▸ StaticgetGovProposalsProposalId<Return>(parameters: { proposalId: string }, options?: IRequestConfiguration): Promise<Return>

description Query a proposal

description Query a proposal by id

200 - OK
400 - Invalid proposal id
500 - Internal Server Error

method getGovProposalsProposalId

see /gov/proposals/{proposalId}

Type parameters:

Name	Default
`Return`	TextProposal

Parameters:

Name	Type	Description
`parameters`	object
`parameters.proposalId`	string	(in path)
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/GovernanceService.ts:462

getGovProposalsProposalIdDeposits

▸ StaticgetGovProposalsProposalIdDeposits<Return>(parameters: { proposalId: string }, options?: IRequestConfiguration): Promise<Return>

description Query deposits

description Query deposits by proposalId

200 - OK
400 - Invalid proposal id
500 - Internal Server Error

method getGovProposalsProposalIdDeposits

see /gov/proposals/{proposalId}/deposits

Type parameters:

Name	Default
`Return`	Deposit[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.proposalId`	string	(in path)
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/GovernanceService.ts:495

getGovProposalsProposalIdDepositsDepositor

▸ StaticgetGovProposalsProposalIdDepositsDepositor<Return>(parameters: { depositor: string ; proposalId: string }, options?: IRequestConfiguration): Promise<Return>

description Query deposit

description Query deposit by proposalId and depositor address

200 - OK
400 - Invalid proposal id or depositor address
404 - Found no deposit
500 - Internal Server Error

method getGovProposalsProposalIdDepositsDepositor

see /gov/proposals/{proposalId}/deposits/{depositor}

Type parameters:

Name	Default
`Return`	Deposit

Parameters:

Name	Type	Description
`parameters`	object
`parameters.depositor`	string	(in path) - Bech32 depositor address
`parameters.proposalId`	string	(in path) - proposal id
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/GovernanceService.ts:572

getGovProposalsProposalIdProposer

▸ StaticgetGovProposalsProposalIdProposer<Return>(parameters: { proposalId: string }, options?: IRequestConfiguration): Promise<Return>

description Query proposer

description Query for the proposer for a proposal

200 - OK
400 - Invalid proposal ID
500 - Internal Server Error

method getGovProposalsProposalIdProposer

see /gov/proposals/{proposalId}/proposer

Type parameters:

Name	Default
`Return`	Proposer

Parameters:

Name	Type	Description
`parameters`	object
`parameters.proposalId`	string	(in path)
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/GovernanceService.ts:608

getGovProposalsProposalIdTally

▸ StaticgetGovProposalsProposalIdTally<Return>(parameters: { proposalId: string }, options?: IRequestConfiguration): Promise<Return>

description Get a proposal's tally result at the current time

description Gets a proposal's tally result at the current time. If the proposal is pending deposits (i.e status 'DepositPeriod') it returns an empty tally result.

200 - OK
400 - Invalid proposal id
500 - Internal Server Error

method getGovProposalsProposalIdTally

see /gov/proposals/{proposalId}/tally

Type parameters:

Name	Default
`Return`	TallyResult

Parameters:

Name	Type	Description
`parameters`	object
`parameters.proposalId`	string	(in path) - proposal id
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/GovernanceService.ts:641

getGovProposalsProposalIdVotes

▸ StaticgetGovProposalsProposalIdVotes<Return>(parameters: { proposalId: string }, options?: IRequestConfiguration): Promise<Return>

description Query voters

description Query voters information by proposalId

200 - OK
400 - Invalid proposal id
500 - Internal Server Error

method getGovProposalsProposalIdVotes

see /gov/proposals/{proposalId}/votes

Type parameters:

Name	Default
`Return`	Vote[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.proposalId`	string	(in path) - proposal id
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/GovernanceService.ts:674

getGovProposalsProposalIdVotesVoter

▸ StaticgetGovProposalsProposalIdVotesVoter<Return>(parameters: { proposalId: string ; voter: string }, options?: IRequestConfiguration): Promise<Return>

description Query vote

description Query vote information by proposal Id and voter address

200 - OK
400 - Invalid proposal id or voter address
404 - Found no vote
500 - Internal Server Error

method getGovProposalsProposalIdVotesVoter

see /gov/proposals/{proposalId}/votes/{voter}

Type parameters:

Name	Default
`Return`	Vote

Parameters:

Name	Type	Description
`parameters`	object
`parameters.proposalId`	string	(in path) - proposal id
`parameters.voter`	string	(in path) - Bech32 voter address
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/GovernanceService.ts:755

postGovProposals

▸ StaticpostGovProposals<Return>(parameters: { post_proposal_body: { base_req: BaseReq ; description: string ; initial_deposit: Coin[] ; proposal_type: string ; proposer: string ; title: string } }, options?: IRequestConfiguration): Promise<Return>

description Submit a proposal

description Send transaction to submit a proposal

200 - Tx was succesfully generated
400 - Invalid proposal body
500 - Internal Server Error

method postGovProposals

see /gov/proposals

Type parameters:

Name	Default
`Return`	StdTx

Parameters:

Name	Type
`parameters`	object
`parameters.post_proposal_body`	object
`parameters.post_proposal_body.base_req`	BaseReq
`parameters.post_proposal_body.description`	string
`parameters.post_proposal_body.initial_deposit`	Coin[]
`parameters.post_proposal_body.proposal_type`	string
`parameters.post_proposal_body.proposer`	string
`parameters.post_proposal_body.title`	string
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/GovernanceService.ts:371

postGovProposalsParamChange

▸ StaticpostGovProposalsParamChange<Return>(parameters: { post_proposal_body: { base_req: BaseReq ; changes: ParamChange[] ; deposit: Coin[] ; description: string ; proposer: string ; title: string } }, options?: IRequestConfiguration): Promise<Return>

description Generate a parameter change proposal transaction

200 - The transaction was succesfully generated
400 - Invalid proposal body
500 - Internal Server Error

method postGovProposalsParamChange

see /gov/proposals/param_change

Type parameters:

Name	Default
`Return`	StdTx

Parameters:

Name	Type
`parameters`	object
`parameters.post_proposal_body`	object
`parameters.post_proposal_body.base_req`	BaseReq
`parameters.post_proposal_body.changes`	ParamChange[]
`parameters.post_proposal_body.deposit`	Coin[]
`parameters.post_proposal_body.description`	string
`parameters.post_proposal_body.proposer`	string
`parameters.post_proposal_body.title`	string
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/GovernanceService.ts:420

postGovProposalsProposalIdDeposits

▸ StaticpostGovProposalsProposalIdDeposits<Return>(parameters: { post_deposit_body: { amount: Coin[] ; base_req: BaseReq ; depositor: string } ; proposalId: string }, options?: IRequestConfiguration): Promise<Return>

description Deposit tokens to a proposal

description Send transaction to deposit tokens to a proposal

200 - OK
400 - Invalid proposal id or deposit body
401 - Key password is wrong
500 - Internal Server Error

method postGovProposalsProposalIdDeposits

see /gov/proposals/{proposalId}/deposits

Type parameters:

Name	Default
`Return`	BroadcastTxCommitResult

Parameters:

Name	Type	Description
`parameters`	object
`parameters.post_deposit_body`	object	-
`parameters.post_deposit_body.amount`	Coin[]	-
`parameters.post_deposit_body.base_req`	BaseReq	-
`parameters.post_deposit_body.depositor`	string	-
`parameters.proposalId`	string	(in path) - proposal id
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/GovernanceService.ts:534

postGovProposalsProposalIdVotes

▸ StaticpostGovProposalsProposalIdVotes<Return>(parameters: { post_vote_body: { base_req: BaseReq ; option: string ; voter: string } ; proposalId: string }, options?: IRequestConfiguration): Promise<Return>

description Vote a proposal

description Send transaction to vote a proposal

200 - OK
400 - Invalid proposal id or vote body
401 - Key password is wrong
500 - Internal Server Error

method postGovProposalsProposalIdVotes

see /gov/proposals/{proposalId}/votes

Type parameters:

Name	Default
`Return`	BroadcastTxCommitResult

Parameters:

Name	Type	Description
`parameters`	object
`parameters.post_vote_body`	object	-
`parameters.post_vote_body.base_req`	BaseReq	-
`parameters.post_vote_body.option`	string	-
`parameters.post_vote_body.voter`	string	-
`parameters.proposalId`	string	(in path) - proposal id
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/GovernanceService.ts:713

JSDK / cosmos/MarketsService / MarketsService

Class: MarketsService

cosmos/MarketsService.MarketsService

Constructors

constructor

Properties

getConfigurations
request

Methods

getMarkets
getMarketsMarketId

Constructors

constructor

+ new MarketsService(): MarketsService

Returns: MarketsService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: cosmos/rests/axios.ts:62

Defined in: cosmos/MarketsService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: cosmos/rests/axios.ts:29

Defined in: cosmos/MarketsService.ts:210

Methods

getMarkets

▸ StaticgetMarkets<Return>(parameters: { baseAssetDenom?: string ; limit?: number ; page?: number ; quoteAssetDenom?: string }, options?: IRequestConfiguration): Promise<Return>

description Get markets

description Get array of Market objects with pagination and filters

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getMarkets

see /markets

Type parameters:

Name	Default
`Return`	RestMarketsRespGetMarkets

Parameters:

Name	Type	Description
`parameters`	object
`parameters.baseAssetDenom?`	string	(in query) - BaseAsset denom filter
`parameters.limit?`	number	(in query) - items per page (default: 100)
`parameters.page?`	number	(in query) - page number (first page: 1)
`parameters.quoteAssetDenom?`	string	(in query) - QuoteAsset denom filter
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/MarketsService.ts:234

getMarketsMarketId

▸ StaticgetMarketsMarketId<Return>(parameters: { marketID: string }, options?: IRequestConfiguration): Promise<Return>

description Get market

description Get Market object by marketID

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getMarketsMarketId

see /markets/{marketID}

Type parameters:

Name	Default
`Return`	RestMarketsRespGetMarket

Parameters:

Name	Type	Description
`parameters`	object
`parameters.marketID`	string	(in path) - marketID
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/MarketsService.ts:277

JSDK / cosmos/MintService / MintService

Class: MintService

cosmos/MintService.MintService

Constructors

constructor

Properties

getConfigurations
request

Methods

getMintingAnnualProvisions
getMintingInflation
getMintingMinterExtended
getMintingParameters

Constructors

constructor

+ new MintService(): MintService

Returns: MintService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: cosmos/rests/axios.ts:62

Defined in: cosmos/MintService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: cosmos/rests/axios.ts:29

Defined in: cosmos/MintService.ts:210

Methods

getMintingAnnualProvisions

▸ StaticgetMintingAnnualProvisions<Return>(options?: IRequestConfiguration): Promise<Return>

description Current minting annual provisions value

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getMintingAnnualProvisions

see /minting/annual-provisions

Type parameters:

Name	Default
`Return`	RestQueryDecResp

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/MintService.ts:229

getMintingInflation

▸ StaticgetMintingInflation<Return>(options?: IRequestConfiguration): Promise<Return>

description Current minting inflation value

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getMintingInflation

see /minting/inflation

Type parameters:

Name	Default
`Return`	RestQueryDecResp

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/MintService.ts:255

getMintingMinterExtended

▸ StaticgetMintingMinterExtended<Return>(options?: IRequestConfiguration): Promise<Return>

description Current minting extended state

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getMintingMinterExtended

see /minting/minter-extended

Type parameters:

Name	Default
`Return`	RestQueryMinterExtendedResp

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/MintService.ts:281

getMintingParameters

▸ StaticgetMintingParameters<Return>(options?: IRequestConfiguration): Promise<Return>

description Minting module parameters

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getMintingParameters

see /minting/parameters

Type parameters:

Name	Default
`Return`	RestQueryParamsResp

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/MintService.ts:307

JSDK / cosmos/MultisigService / MultisigService

Class: MultisigService

cosmos/MultisigService.MultisigService

Constructors

constructor

Properties

getConfigurations
request

Methods

getMultisigCallCallId
getMultisigCalls
getMultisigUniqueUniqueId
putMultisigConfirm
putMultisigRevoke

Constructors

constructor

+ new MultisigService(): MultisigService

Returns: MultisigService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: cosmos/rests/axios.ts:62

Defined in: cosmos/MultisigService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: cosmos/rests/axios.ts:29

Defined in: cosmos/MultisigService.ts:210

Methods

getMultisigCallCallId

▸ StaticgetMultisigCallCallId<Return>(parameters: { callID: number }, options?: IRequestConfiguration): Promise<Return>

description Get call

description Get call object by it's ID

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getMultisigCallCallId

see /multisig/call/{callID}

Type parameters:

Name	Default
`Return`	RestMsRespGetCall

Parameters:

Name	Type	Description
`parameters`	object
`parameters.callID`	number	(in path) - callID
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/MultisigService.ts:231

getMultisigCalls

▸ StaticgetMultisigCalls<Return>(options?: IRequestConfiguration): Promise<Return>

description Get active calls

description Get active call objects

200 - OK
500 - Returned on server error

method getMultisigCalls

see /multisig/calls

Type parameters:

Name	Default
`Return`	RestMsRespGetCalls

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/MultisigService.ts:261

getMultisigUniqueUniqueId

▸ StaticgetMultisigUniqueUniqueId<Return>(parameters: { uniqueID: string }, options?: IRequestConfiguration): Promise<Return>

description Get call

description Get call object by it's uniqueID

200 - OK
500 - Returned on server error

method getMultisigUniqueUniqueId

see /multisig/unique/{uniqueID}

Type parameters:

Name	Default
`Return`	RestMsRespGetCall

Parameters:

Name	Type	Description
`parameters`	object
`parameters.uniqueID`	string	(in path) - call uniqueID
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/MultisigService.ts:358

putMultisigConfirm

▸ StaticputMultisigConfirm<Return>(parameters: { request: RestConfirmReq }, options?: IRequestConfiguration): Promise<Return>

description Confirm call

description Get confirm multi signature call by PoA validator stdTx object

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method putMultisigConfirm

see /multisig/confirm

Type parameters:

Name	Default
`Return`	RestCcRespStdTx

Parameters:

Name	Type	Description
`parameters`	object
`parameters.request`	RestConfirmReq	(in body) - Confirm request
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/MultisigService.ts:289

putMultisigRevoke

▸ StaticputMultisigRevoke<Return>(parameters: { request: RestRevokeReq }, options?: IRequestConfiguration): Promise<Return>

description Revoke call

description Get revoke multi signature call vote by PoA validator stdTx object

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method putMultisigRevoke

see /multisig/revoke

Type parameters:

Name	Default
`Return`	RestCcRespStdTx

Parameters:

Name	Type	Description
`parameters`	object
`parameters.request`	RestRevokeReq	(in body) - Revoke request
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/MultisigService.ts:324

JSDK / cosmos/OracleService / OracleService

Class: OracleService

cosmos/OracleService.OracleService

Constructors

constructor

Properties

getConfigurations
request

Methods

getOracleAssets
getOracleCurrentpriceAssetCode
getOracleRawpricesAssetCodeBlockHeight
putOracleRawprices

Constructors

constructor

+ new OracleService(): OracleService

Returns: OracleService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: cosmos/rests/axios.ts:62

Defined in: cosmos/OracleService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: cosmos/rests/axios.ts:29

Defined in: cosmos/OracleService.ts:210

Methods

getOracleAssets

▸ StaticgetOracleAssets<Return>(options?: IRequestConfiguration): Promise<Return>

description Get assets

description Get asset objects

200 - OK
400 - Returned if the request doesn't have valid query params
404 - Returned if requested data wasn't found
500 - Returned on server error

method getOracleAssets

see /oracle/assets

Type parameters:

Name	Default
`Return`	RestOracleRespGetAssets

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/OracleService.ts:230

getOracleCurrentpriceAssetCode

▸ StaticgetOracleCurrentpriceAssetCode<Return>(parameters: { assetCode: string }, options?: IRequestConfiguration): Promise<Return>

description Get current Price

description Get current Price by assetCode

200 - OK
400 - Returned if the request doesn't have valid query params
404 - Returned if requested data wasn't found
500 - Returned on server error

method getOracleCurrentpriceAssetCode

see /oracle/currentprice/{assetCode}

Type parameters:

Name	Default
`Return`	RestOracleRespGetPrice

Parameters:

Name	Type	Description
`parameters`	object
`parameters.assetCode`	string	(in path) - asset code
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/OracleService.ts:259

getOracleRawpricesAssetCodeBlockHeight

▸ StaticgetOracleRawpricesAssetCodeBlockHeight<Return>(parameters: { assetCode: string ; blockHeight: number }, options?: IRequestConfiguration): Promise<Return>

description Get rawPrices

description Get rawPrice objects by assetCode and blockHeight

200 - OK
400 - Returned if the request doesn't have valid query params
404 - Returned if requested data wasn't found
500 - Returned on server error

method getOracleRawpricesAssetCodeBlockHeight

see /oracle/rawprices/{assetCode}/{blockHeight}

Type parameters:

Name	Default
`Return`	RestOracleRespGetRawPrices

Parameters:

Name	Type	Description
`parameters`	object
`parameters.assetCode`	string	(in path) - asset code
`parameters.blockHeight`	number	(in path) - block height rawPrices relates to
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/OracleService.ts:329

putOracleRawprices

▸ StaticputOracleRawprices<Return>(parameters: { postRequest: RestPostPriceReq }, options?: IRequestConfiguration): Promise<Return>

description Post asset rawPrice

description Send asset rawPrice signed Tx

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method putOracleRawprices

see /oracle/rawprices

Type parameters:

Name	Default
`Return`	RestOracleRespGetAssets

Parameters:

Name	Type	Description
`parameters`	object
`parameters.postRequest`	RestPostPriceReq	(in body) - PostPrice request with signed transaction
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/OracleService.ts:292

JSDK / cosmos/OrdersService / OrdersService

Class: OrdersService

cosmos/OrdersService.OrdersService

Constructors

constructor

Properties

getConfigurations
request

Methods

getOrders
getOrdersOrderId
putOrdersPost
putOrdersRevoke

Constructors

constructor

+ new OrdersService(): OrdersService

Returns: OrdersService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: cosmos/rests/axios.ts:62

Defined in: cosmos/OrdersService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: cosmos/rests/axios.ts:29

Defined in: cosmos/OrdersService.ts:210

Methods

getOrders

▸ StaticgetOrders<Return>(parameters: { direction?: string ; limit?: number ; marketID?: string ; owner?: string ; page?: number }, options?: IRequestConfiguration): Promise<Return>

description Get orders

description Get array of Order objects with pagination and filters

200 - OK
400 - Returned if the request doesn't have valid query/path params
500 - Returned on server error

method getOrders

see /orders

Type parameters:

Name	Default
`Return`	RestOrdersRespGetOrders

Parameters:

Name	Type	Description
`parameters`	object
`parameters.direction?`	string	(in query) - direction filter (bid/ask)
`parameters.limit?`	number	(in query) - items per page (default: 100)
`parameters.marketID?`	string	(in query) - marketID filter (bid/ask)
`parameters.owner?`	string	(in query) - owner filter
`parameters.page?`	number	(in query) - page number (first page: 1)
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/OrdersService.ts:235

getOrdersOrderId

▸ StaticgetOrdersOrderId<Return>(parameters: { orderID: string }, options?: IRequestConfiguration): Promise<Return>

description Get order

description Get Order object by orderID

200 - OK
400 - Returned if the request doesn't have valid query/path params
500 - Returned on server error

method getOrdersOrderId

see /orders/{orderID}

Type parameters:

Name	Default
`Return`	RestOrdersRespGetOrder

Parameters:

Name	Type	Description
`parameters`	object
`parameters.orderID`	string	(in path) - orderID
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/OrdersService.ts:350

putOrdersPost

▸ StaticputOrdersPost<Return>(parameters: { postRequest: RestPostOrderReq }, options?: IRequestConfiguration): Promise<Return>

description Post new order

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method putOrdersPost

see /orders/post

Type parameters:

Name	Default
`Return`	RestOrdersRespPostOrder

Parameters:

Name	Type	Description
`parameters`	object
`parameters.postRequest`	RestPostOrderReq	(in body) - PostOrder request with signed transaction
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/OrdersService.ts:280

putOrdersRevoke

▸ StaticputOrdersRevoke<Return>(parameters: { postRequest: RestRevokeOrderReq }, options?: IRequestConfiguration): Promise<Return>

description Revoke order

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method putOrdersRevoke

see /orders/revoke

Type parameters:

Name	Default
`Return`	RestOrdersRespRevokeOrder

Parameters:

Name	Type	Description
`parameters`	object
`parameters.postRequest`	RestRevokeOrderReq	(in body) - RevokeOrder request with signed transaction
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/OrdersService.ts:315

JSDK / cosmos/PoAService / PoAService

Class: PoAService

cosmos/PoAService.PoAService

Constructors

constructor

Properties

getConfigurations
request

Methods

getPoaValidators

Constructors

constructor

+ new PoAService(): PoAService

Returns: PoAService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: cosmos/rests/axios.ts:62

Defined in: cosmos/PoAService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: cosmos/rests/axios.ts:29

Defined in: cosmos/PoAService.ts:210

Methods

getPoaValidators

▸ StaticgetPoaValidators<Return>(options?: IRequestConfiguration): Promise<Return>

description Get validators

description Get validator objects and required confirmations count

200 - OK
500 - Returned on server error

method getPoaValidators

see /poa/validators

Type parameters:

Name	Default
`Return`	RestPoaRespGetValidators

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/PoAService.ts:228

JSDK / cosmos/SlashingService / SlashingService

Class: SlashingService

cosmos/SlashingService.SlashingService

Constructors

constructor

Properties

getConfigurations
request

Methods

getSlashingParameters
getSlashingSigningInfos
postSlashingValidatorsValidatorAddrUnjail

Constructors

constructor

+ new SlashingService(): SlashingService

Returns: SlashingService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: cosmos/rests/axios.ts:62

Defined in: cosmos/SlashingService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: cosmos/rests/axios.ts:29

Defined in: cosmos/SlashingService.ts:210

Methods

getSlashingParameters

▸ StaticgetSlashingParameters<Return>(options?: IRequestConfiguration): Promise<Return>

description Get the current slashing parameters

200 - OK
500 - Internal Server Error

method getSlashingParameters

see /slashing/parameters

Type parameters:

Name	Default
`Return`	{ `double_sign_unbond_duration`: string ; `downtime_unbond_duration`: string ; `max_evidence_age`: string ; `min_signed_per_window`: string ; `signed_blocks_window`: string ; `slash_fraction_double_sign`: string ; `slash_fraction_downtime`: string }

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

{Promise<{ double_sign_unbond_duration: string, downtime_unbond_duration: string, max_evidence_age: string, min_signed_per_window: string, signed_blocks_window: string, slash_fraction_double_sign: string, slash_fraction_downtime: string }>}

Defined in: cosmos/SlashingService.ts:235

getSlashingSigningInfos

▸ StaticgetSlashingSigningInfos<Return>(parameters: { limit: number ; page: number }, options?: IRequestConfiguration): Promise<Return>

description Get sign info of given all validators

description Get sign info of all validators

200 - OK
400 - Invalid validator public key for one of the validators
500 - Internal Server Error

method getSlashingSigningInfos

see /slashing/signing_infos

Type parameters:

Name	Default
`Return`	SigningInfo[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.limit`	number	(in query) - Maximum number of items per page
`parameters.page`	number	(in query) - Page number
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/SlashingService.ts:274

postSlashingValidatorsValidatorAddrUnjail

▸ StaticpostSlashingValidatorsValidatorAddrUnjail<Return>(parameters: { UnjailBody: { base_req: StdTx } ; validatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Unjail a jailed validator

description Send transaction to unjail a jailed validator

200 - Tx was succesfully generated
400 - Invalid validator address or base_req
500 - Internal Server Error

method postSlashingValidatorsValidatorAddrUnjail

see /slashing/validators/{validatorAddr}/unjail

Type parameters:

Name	Default
`Return`	BroadcastTxCommitResult

Parameters:

Name	Type	Description
`parameters`	object
`parameters.UnjailBody`	object	-
`parameters.UnjailBody.base_req`	StdTx	-
`parameters.validatorAddr`	string	(in path) - Bech32 validator address
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/SlashingService.ts:313

JSDK / cosmos/StakingService / StakingService

Class: StakingService

cosmos/StakingService.StakingService

Constructors

constructor

Properties

getConfigurations
request

Methods

getStakingDelegatorsDelegatorAddrDelegations
getStakingDelegatorsDelegatorAddrDelegationsValidatorAddr
getStakingDelegatorsDelegatorAddrTxs
getStakingDelegatorsDelegatorAddrUnbondingDelegations
getStakingDelegatorsDelegatorAddrUnbondingDelegationsValidatorAddr
getStakingDelegatorsDelegatorAddrValidators
getStakingDelegatorsDelegatorAddrValidatorsValidatorAddr
getStakingHistoricalInfoHeight
getStakingParameters
getStakingPool
getStakingRedelegations
getStakingValidators
getStakingValidatorsValidatorAddr
getStakingValidatorsValidatorAddrDelegations
getStakingValidatorsValidatorAddrUnbondingDelegations
postStakingDelegatorsDelegatorAddrDelegations
postStakingDelegatorsDelegatorAddrRedelegations
postStakingDelegatorsDelegatorAddrUnbondingDelegations

Constructors

constructor

+ new StakingService(): StakingService

Returns: StakingService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: cosmos/rests/axios.ts:62

Defined in: cosmos/StakingService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: cosmos/rests/axios.ts:29

Defined in: cosmos/StakingService.ts:210

Methods

getStakingDelegatorsDelegatorAddrDelegations

▸ StaticgetStakingDelegatorsDelegatorAddrDelegations<Return>(parameters: { delegatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Get all delegations from a delegator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getStakingDelegatorsDelegatorAddrDelegations

see /staking/delegators/{delegatorAddr}/delegations

Type parameters:

Name	Default
`Return`	RestQueryDelegationsResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/StakingService.ts:231

getStakingDelegatorsDelegatorAddrDelegationsValidatorAddr

▸ StaticgetStakingDelegatorsDelegatorAddrDelegationsValidatorAddr<Return>(parameters: { delegatorAddr: string ; validatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Query the current delegation between a delegator and a validator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getStakingDelegatorsDelegatorAddrDelegationsValidatorAddr

see /staking/delegators/{delegatorAddr}/delegations/{validatorAddr}

Type parameters:

Name	Default
`Return`	RestQueryDelegationResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`parameters.validatorAddr`	string	(in path) - Bech32 OperatorAddress of validator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/StakingService.ts:302

getStakingDelegatorsDelegatorAddrTxs

▸ StaticgetStakingDelegatorsDelegatorAddrTxs<Return>(parameters: { delegatorAddr: string ; type?: string }, options?: IRequestConfiguration): Promise<Return>

description Query all staking txs (msgs) from a delegator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getStakingDelegatorsDelegatorAddrTxs

see /staking/delegators/{delegatorAddr}/txs

Type parameters:

Name	Default
`Return`	TypesSearchTxsResult[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`parameters.type?`	string	(in query) - Unbonding types via space: bond unbond redelegate
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/StakingService.ts:376

getStakingDelegatorsDelegatorAddrUnbondingDelegations

▸ StaticgetStakingDelegatorsDelegatorAddrUnbondingDelegations<Return>(parameters: { delegatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Get all unbonding delegations from a delegator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getStakingDelegatorsDelegatorAddrUnbondingDelegations

see /staking/delegators/{delegatorAddr}/unbonding_delegations

Type parameters:

Name	Default
`Return`	RestQueryUnbondingDelegationsResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/StakingService.ts:412

getStakingDelegatorsDelegatorAddrUnbondingDelegationsValidatorAddr

▸ StaticgetStakingDelegatorsDelegatorAddrUnbondingDelegationsValidatorAddr<Return>(parameters: { delegatorAddr: string ; validatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Query all unbonding delegations between a delegator and a validator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getStakingDelegatorsDelegatorAddrUnbondingDelegationsValidatorAddr

see /staking/delegators/{delegatorAddr}/unbonding_delegations/{validatorAddr}

Type parameters:

Name	Default
`Return`	RestQueryUnbondingDelegationResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`parameters.validatorAddr`	string	(in path) - Bech32 OperatorAddress of validator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/StakingService.ts:489

getStakingDelegatorsDelegatorAddrValidators

▸ StaticgetStakingDelegatorsDelegatorAddrValidators<Return>(parameters: { delegatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Query all validators that a delegator is bonded to

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getStakingDelegatorsDelegatorAddrValidators

see /staking/delegators/{delegatorAddr}/validators

Type parameters:

Name	Default
`Return`	RestQueryValidatorsResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/StakingService.ts:525

getStakingDelegatorsDelegatorAddrValidatorsValidatorAddr

▸ StaticgetStakingDelegatorsDelegatorAddrValidatorsValidatorAddr<Return>(parameters: { delegatorAddr: string ; validatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Query a validator that a delegator is bonded to

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getStakingDelegatorsDelegatorAddrValidatorsValidatorAddr

see /staking/delegators/{delegatorAddr}/validators/{validatorAddr}

Type parameters:

Name	Default
`Return`	RestQueryValidatorResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`parameters.validatorAddr`	string	(in path) - Bech32 ValAddress of Delegator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/StakingService.ts:559

getStakingHistoricalInfoHeight

▸ StaticgetStakingHistoricalInfoHeight<Return>(parameters: { height: string }, options?: IRequestConfiguration): Promise<Return>

description Query historical info at a given height

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getStakingHistoricalInfoHeight

see /staking/historical_info/{height}

Type parameters:

Name	Default
`Return`	RestQueryHistoricalInfoResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.height`	string	(in path) - block height
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/StakingService.ts:595

getStakingParameters

▸ StaticgetStakingParameters<Return>(options?: IRequestConfiguration): Promise<Return>

description Get the current staking parameter values

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getStakingParameters

see /staking/parameters

Type parameters:

Name	Default
`Return`	RestQueryParamsResp

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/StakingService.ts:626

getStakingPool

▸ StaticgetStakingPool<Return>(options?: IRequestConfiguration): Promise<Return>

description Get the current state of the staking pool

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getStakingPool

see /staking/pool

Type parameters:

Name	Default
`Return`	RestQueryPoolResp

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/StakingService.ts:652

getStakingRedelegations

▸ StaticgetStakingRedelegations<Return>(parameters: { delegator?: string ; validator_from?: string ; validator_to?: string }, options?: IRequestConfiguration): Promise<Return>

description Get all redelegations (filter by query params)

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getStakingRedelegations

see /staking/redelegations

Type parameters:

Name	Default
`Return`	RestQueryRedelegationsResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegator?`	string	(in query) - Bech32 AccAddress of Delegator
`parameters.validator_from?`	string	(in query) - Bech32 AccAddress of SrcValidator
`parameters.validator_to?`	string	(in query) - Bech32 AccAddress of DstValidator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/StakingService.ts:682

getStakingValidators

▸ StaticgetStakingValidators<Return>(parameters: { limit?: string ; page?: string ; status?: string }, options?: IRequestConfiguration): Promise<Return>

description Get all validator candidates. By default it returns only the bonded validators

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getStakingValidators

see /staking/validators

Type parameters:

Name	Default
`Return`	RestQueryValidatorsResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.limit?`	string	(in query) - The maximum number of items per page
`parameters.page?`	string	(in query) - The page number
`parameters.status?`	string	(in query) - The validator bond status. Must be either 'bonded', 'unbonded', or 'unbonding'
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/StakingService.ts:725

getStakingValidatorsValidatorAddr

▸ StaticgetStakingValidatorsValidatorAddr<Return>(parameters: { validatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Query the information from a single validator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getStakingValidatorsValidatorAddr

see /staking/validators/{validatorAddr}

Type parameters:

Name	Default
`Return`	RestQueryValidatorResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.validatorAddr`	string	(in path) - Bech32 ValAddress
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/StakingService.ts:762

getStakingValidatorsValidatorAddrDelegations

▸ StaticgetStakingValidatorsValidatorAddrDelegations<Return>(parameters: { validatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Get the current delegations for the validator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getStakingValidatorsValidatorAddrDelegations

see /staking/validators/{validatorAddr}/delegations

Type parameters:

Name	Default
`Return`	RestQueryDelegationsResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.validatorAddr`	string	(in path) - Bech32 ValAddress
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/StakingService.ts:795

getStakingValidatorsValidatorAddrUnbondingDelegations

▸ StaticgetStakingValidatorsValidatorAddrUnbondingDelegations<Return>(parameters: { validatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Get the current unbonding information for the validator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getStakingValidatorsValidatorAddrUnbondingDelegations

see /staking/validators/{validatorAddr}/unbonding_delegations

Type parameters:

Name	Default
`Return`	RestQueryUnbondingDelegationsResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.validatorAddr`	string	(in path) - Bech32 ValAddress
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/StakingService.ts:828

postStakingDelegatorsDelegatorAddrDelegations

▸ StaticpostStakingDelegatorsDelegatorAddrDelegations<Return>(parameters: { delegatorAddr: string ; postRequest: RestDelegateRequest }, options?: IRequestConfiguration): Promise<Return>

description Submit delegation

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method postStakingDelegatorsDelegatorAddrDelegations

see /staking/delegators/{delegatorAddr}/delegations

Type parameters:

Name	Default
`Return`	TypesMsgDelegate[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`parameters.postRequest`	RestDelegateRequest	(in body) - DelegateRequest request with signed transaction
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/StakingService.ts:265

postStakingDelegatorsDelegatorAddrRedelegations

▸ StaticpostStakingDelegatorsDelegatorAddrRedelegations<Return>(parameters: { delegatorAddr: string ; postRequest: RestRedelegateRequest }, options?: IRequestConfiguration): Promise<Return>

description Submit a redelegation

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method postStakingDelegatorsDelegatorAddrRedelegations

see /staking/delegators/{delegatorAddr}/redelegations

Type parameters:

Name	Default
`Return`	RestTxBeginRedelegate[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`parameters.postRequest`	RestRedelegateRequest	(in body) - RedelegateRequest request with signed transaction
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/StakingService.ts:339

postStakingDelegatorsDelegatorAddrUnbondingDelegations

▸ StaticpostStakingDelegatorsDelegatorAddrUnbondingDelegations<Return>(parameters: { delegatorAddr: string ; postRequest: RestUndelegateRequest }, options?: IRequestConfiguration): Promise<Return>

description Submit an unbonding delegation

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method postStakingDelegatorsDelegatorAddrUnbondingDelegations

see /staking/delegators/{delegatorAddr}/unbonding_delegations

Type parameters:

Name	Default
`Return`	RestTxUndelegate[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`parameters.postRequest`	RestUndelegateRequest	(in body) - RedelegateRequest request with signed transaction
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/StakingService.ts:449

JSDK / cosmos/SupplyService / SupplyService

Class: SupplyService

cosmos/SupplyService.SupplyService

Constructors

constructor

Properties

getConfigurations
request

Methods

getSupplyTotal
getSupplyTotalDenomination

Constructors

constructor

+ new SupplyService(): SupplyService

Returns: SupplyService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: cosmos/rests/axios.ts:62

Defined in: cosmos/SupplyService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: cosmos/rests/axios.ts:29

Defined in: cosmos/SupplyService.ts:210

Methods

getSupplyTotal

▸ StaticgetSupplyTotal<Return>(options?: IRequestConfiguration): Promise<Return>

description Total supply of coins in the chain

200 - OK
500 - Internal Server Error

method getSupplyTotal

see /supply/total

Type parameters:

Name	Default
`Return`	Supply

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/SupplyService.ts:227

getSupplyTotalDenomination

▸ StaticgetSupplyTotalDenomination<Return>(parameters: { denomination: string }, options?: IRequestConfiguration): Promise<Return>

description Total supply of a single coin denomination

200 - OK
400 - Invalid coin denomination
500 - Internal Server Error

method getSupplyTotalDenomination

see /supply/total/{denomination}

Type parameters:

Name	Default
`Return`	string

Parameters:

Name	Type	Description
`parameters`	object
`parameters.denomination`	string	(in path) - Coin denomination
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/SupplyService.ts:254

JSDK / cosmos/TendermintRpcService / TendermintRpcService

Class: TendermintRpcService

cosmos/TendermintRpcService.TendermintRpcService

Constructors

constructor

Properties

getConfigurations
request

Methods

getBlocksHeight
getBlocksLatest
getNodeInfo
getSyncing
getValidatorsetsHeight
getValidatorsetsLatest

Constructors

constructor

+ new TendermintRpcService(): TendermintRpcService

Returns: TendermintRpcService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: cosmos/rests/axios.ts:62

Defined in: cosmos/TendermintRpcService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: cosmos/rests/axios.ts:29

Defined in: cosmos/TendermintRpcService.ts:210

Methods

getBlocksHeight

▸ StaticgetBlocksHeight<Return>(parameters: { height: number }, options?: IRequestConfiguration): Promise<Return>

description Get a block at a certain height

200 - The block at a specific height
400 - Invalid height
404 - Request block height doesn't
500 - Server internal error

method getBlocksHeight

see /blocks/{height}

Type parameters:

Name	Default
`Return`	BlockQuery

Parameters:

Name	Type	Description
`parameters`	object
`parameters.height`	number	(in path) - Block height
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/TendermintRpcService.ts:255

getBlocksLatest

▸ StaticgetBlocksLatest<Return>(options?: IRequestConfiguration): Promise<Return>

description Get the latest block

200 - The latest block
500 - Server internal error

method getBlocksLatest

see /blocks/latest

Type parameters:

Name	Default
`Return`	BlockQuery

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/TendermintRpcService.ts:227

getNodeInfo

▸ StaticgetNodeInfo<Return>(options?: IRequestConfiguration): Promise<Return>

description The properties of the connected node

description Information about the connected node

200 - Node status
500 - Failed to query node status

method getNodeInfo

see /node_info

Type parameters:

Name Default

Return { application_version: { build_tags: string ; client_name: string ; commit: string ; go: string ; name: string ; server_name: string ; version: string } ; node_info: { channels: string ; id: string ; listen_addr: string ; moniker: string ; network: string ; other: { rpc_address: string ; tx_index: string } ; protocol_version: { app: string ; block: string ; p2p: string } ; version: string } }

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

{Promise<{ application_version: { * build_tags: string, * client_name: string, * commit: string, * go: string, * name: string, * server_name: string, * version: string }, node_info: { * channels: string, * id: string, * listen_addr: string, * moniker: string, * network: string, * other: { * * rpc_address: string, * * tx_index: string * }, * protocol_version: { * * app: string, * * block: string, * * p2p: string * }, * version: string } }>}

Defined in: cosmos/TendermintRpcService.ts:312

getSyncing

▸ StaticgetSyncing<Return>(options?: IRequestConfiguration): Promise<Return>

description Syncing state of node

description Get if the node is currently syning with other nodes

200 - Node syncing status
500 - Server internal error

method getSyncing

see /syncing

Type parameters:

Name	Default
`Return`	{ `syncing`: boolean }

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

{Promise<{ syncing: boolean }>}

Defined in: cosmos/TendermintRpcService.ts:361

getValidatorsetsHeight

▸ StaticgetValidatorsetsHeight<Return>(parameters: { height: number }, options?: IRequestConfiguration): Promise<Return>

description Get a validator set a certain height

200 - The validator set at a specific block height
400 - Invalid height
404 - Block at height not available
500 - Server internal error

method getValidatorsetsHeight

see /validatorsets/{height}

Type parameters:

Name	Default
`Return`	{ `block_height`: string ; `validators`: TendermintValidator[] }

Parameters:

Name	Type	Description
`parameters`	object
`parameters.height`	number	(in path) - Block height
`options?`	IRequestConfiguration

Returns: Promise<Return>

{Promise<{ block_height: string, validators: TendermintValidator[] }>}

Defined in: cosmos/TendermintRpcService.ts:421

getValidatorsetsLatest

▸ StaticgetValidatorsetsLatest<Return>(options?: IRequestConfiguration): Promise<Return>

description Get the latest validator set

200 - The validator set at the latest block height
500 - Server internal error

method getValidatorsetsLatest

see /validatorsets/latest

Type parameters:

Name	Default
`Return`	{ `block_height`: string ; `validators`: TendermintValidator[] }

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

{Promise<{ block_height: string, validators: TendermintValidator[] }>}

Defined in: cosmos/TendermintRpcService.ts:388

JSDK / cosmos/TransactionsService / TransactionsService

Class: TransactionsService

cosmos/TransactionsService.TransactionsService

Constructors

constructor

Properties

getConfigurations
request

Methods

getTxs
getTxsHash
postTxs
postTxsDecode
postTxsEncode

Constructors

constructor

+ new TransactionsService(): TransactionsService

Returns: TransactionsService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: cosmos/rests/axios.ts:62

Defined in: cosmos/TransactionsService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: cosmos/rests/axios.ts:29

Defined in: cosmos/TransactionsService.ts:210

Methods

getTxs

▸ StaticgetTxs<Return>(parameters: { limit?: number ; message.action?: string ; message.sender?: string ; page?: number ; tx.maxheight?: number ; tx.minheight?: number }, options?: IRequestConfiguration): Promise<Return>

description Search transactions

description Search transactions by events.

200 - All txs matching the provided events
400 - Invalid search events
500 - Internal Server Error

method getTxs

see /txs

Type parameters:

Name	Default
`Return`	PaginatedQueryTxs

Parameters:

Name	Type	Description
`parameters`	object
`parameters.limit?`	number	(in query) - Maximum number of items per page
`parameters.message.action?`	string	(in query) - transaction events such as 'message.action=send' which results in the following endpoint: 'GET /txs?message.action=send'. note that each module documents its own events. look for xx_events.md in the corresponding cosmos-sdk/docs/spec directory
`parameters.message.sender?`	string	(in query) - transaction tags with sender: 'GET /txs?message.action=send&message.sender=cosmos16xyempempp92x9hyzz9wrgf94r6j9h5f06pxxv'
`parameters.page?`	number	(in query) - Page number
`parameters.tx.maxheight?`	number	(in query) - transactions on blocks with height less than or equal this value
`parameters.tx.minheight?`	number	(in query) - transactions on blocks with height greater or equal this value
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/TransactionsService.ts:236

getTxsHash

▸ StaticgetTxsHash<Return>(parameters: { hash: string }, options?: IRequestConfiguration): Promise<Return>

description Get a Tx by hash

description Retrieve a transaction using its hash.

200 - Tx with the provided hash
500 - Internal Server Error

method getTxsHash

see /txs/{hash}

Type parameters:

Name	Default
`Return`	TxQuery

Parameters:

Name	Type	Description
`parameters`	object
`parameters.hash`	string	(in path) - Tx hash
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/TransactionsService.ts:398

postTxs

▸ StaticpostTxs<Return>(parameters: { txBroadcast: { mode: string ; tx: StdTx } }, options?: IRequestConfiguration): Promise<Return>

description Broadcast a signed tx

description Broadcast a signed tx to a full node

200 - Tx broadcasting result
500 - Internal Server Error

method postTxs

see /txs

Type parameters:

Name	Default
`Return`	BroadcastTxCommitResult

Parameters:

Name	Type
`parameters`	object
`parameters.txBroadcast`	object
`parameters.txBroadcast.mode`	string
`parameters.txBroadcast.tx`	StdTx
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/TransactionsService.ts:285

postTxsDecode

▸ StaticpostTxsDecode<Return>(parameters: { tx: { tx: string } }, options?: IRequestConfiguration): Promise<Return>

description Decode a transaction from the Amino wire format

description Decode a transaction (signed or not) from base64-encoded Amino serialized bytes to JSON

200 - The tx was successfully decoded
400 - The tx was malformated
500 - Server internal error

method postTxsDecode

see /txs/decode

Type parameters:

Name	Default
`Return`	StdTx

Parameters:

Name	Type
`parameters`	object
`parameters.tx`	object
`parameters.tx.tx`	string
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/TransactionsService.ts:325

postTxsEncode

▸ StaticpostTxsEncode<Return>(parameters: { tx: { tx: StdTx } }, options?: IRequestConfiguration): Promise<Return>

description Encode a transaction to the Amino wire format

description Encode a transaction (signed or not) from JSON to base64-encoded Amino serialized bytes

200 - The tx was successfully decoded and re-encoded
400 - The tx was malformated
500 - Server internal error

method postTxsEncode

see /txs/encode

Type parameters:

Name	Default
`Return`	{ `tx`: string }

Parameters:

Name	Type
`parameters`	object
`parameters.tx`	object
`parameters.tx.tx`	StdTx
`options?`	IRequestConfiguration

Returns: Promise<Return>

{Promise<{ tx: string }>}

Defined in: cosmos/TransactionsService.ts:364

JSDK / cosmos/VmService / VmService

Class: VmService

cosmos/VmService.VmService

Constructors

constructor

Properties

getConfigurations
request

Methods

getVmCompile
getVmDataAccountAddrVmPath
getVmTxTxHash
getVmView
putVmExecute
putVmPublish

Constructors

constructor

+ new VmService(): VmService

Returns: VmService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: cosmos/rests/axios.ts:62

Defined in: cosmos/VmService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: cosmos/rests/axios.ts:29

Defined in: cosmos/VmService.ts:210

Methods

getVmCompile

▸ StaticgetVmCompile<Return>(parameters: { getRequest: RestCompileReq }, options?: IRequestConfiguration): Promise<Return>

description Get compiled byteCode

description Compile script / module code using VM and return byteCode

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getVmCompile

see /vm/compile

Type parameters:

Name	Default
`Return`	RestVmRespCompile

Parameters:

Name	Type	Description
`parameters`	object
`parameters.getRequest`	RestCompileReq	(in body) - Code with metadata
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/VmService.ts:231

getVmDataAccountAddrVmPath

▸ StaticgetVmDataAccountAddrVmPath<Return>(parameters: { accountAddr: string ; vmPath: string }, options?: IRequestConfiguration): Promise<Return>

description Get writeSet data from VM

description Get writeSet data from VM by accountAddr and path

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getVmDataAccountAddrVmPath

see /vm/data/{accountAddr}/{vmPath}

Type parameters:

Name	Default
`Return`	RestVmData

Parameters:

Name	Type	Description
`parameters`	object
`parameters.accountAddr`	string	(in path) - account address (Libra HEX Bech32)
`parameters.vmPath`	string	(in path) - VM path (HEX string)
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/VmService.ts:267

getVmTxTxHash

▸ StaticgetVmTxTxHash<Return>(parameters: { txHash: string }, options?: IRequestConfiguration): Promise<Return>

description Get TX VM execution status

description Get TX VM execution status by hash

200 - OK
400 - Returned if the request doesn't have valid query params
404 - Returned if the requested data wasn't found
500 - Returned on server error

method getVmTxTxHash

see /vm/tx/{txHash}

Type parameters:

Name	Default
`Return`	RestVmTxStatus

Parameters:

Name	Type	Description
`parameters`	object
`parameters.txHash`	string	(in path) - transaction hash
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/VmService.ts:374

getVmView

▸ StaticgetVmView<Return>(parameters: { request: RestLcsViewReq }, options?: IRequestConfiguration): Promise<Return>

description Get writeSet data from VM LCS string view

description Get writeSet data LCS string view for {address}::{moduleName}::{structName} Move path"

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getVmView

see /vm/view

Type parameters:

Name	Default
`Return`	RestVmRespLcsView

Parameters:

Name	Type	Description
`parameters`	object
`parameters.request`	RestLcsViewReq	(in body) - View request
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/VmService.ts:407

putVmExecute

▸ StaticputVmExecute<Return>(parameters: { request: RestExecuteScriptReq }, options?: IRequestConfiguration): Promise<Return>

description Execute Move script

description Get execute Move script stdTx object

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method putVmExecute

see /vm/execute

Type parameters:

Name	Default
`Return`	RestVmRespStdTx

Parameters:

Name	Type	Description
`parameters`	object
`parameters.request`	RestExecuteScriptReq	(in body) - Execute request
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/VmService.ts:303

putVmPublish

▸ StaticputVmPublish<Return>(parameters: { request: RestPublishModuleReq }, options?: IRequestConfiguration): Promise<Return>

description Publish Move module

description Get publish Move module stdTx object

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method putVmPublish

see /vm/publish

Type parameters:

Name	Default
`Return`	RestVmRespStdTx

Parameters:

Name	Type	Description
`parameters`	object
`parameters.request`	RestPublishModuleReq	(in body) - Publish request
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: cosmos/VmService.ts:338

JSDK / dfinance / SDK

Class: SDK

dfinance.SDK

Constructors

constructor

Properties

auth
bank
configurations
currencies
distribution
governance
markets
mint
multisig
oracle
orders
poA
slashing
staking
supply
tendermintRpc
transactions
vm

Methods

getConfigurations
request

Constructors

constructor

+ new SDK(configurations?: IRequestConfiguration): SDK

Parameters:

Name	Type	Default value
`configurations`	IRequestConfiguration	{}

Returns: SDK

Defined in: dfinance/index.ts:59

Properties

auth

• auth: typeof AuthService

Defined in: dfinance/index.ts:43

bank

• bank: typeof BankService

Defined in: dfinance/index.ts:44

configurations

• Readonly configurations: IRequestConfiguration= {}

currencies

• currencies: typeof CurrenciesService

Defined in: dfinance/index.ts:45

distribution

• distribution: typeof DistributionService

Defined in: dfinance/index.ts:46

governance

• governance: typeof GovernanceService

Defined in: dfinance/index.ts:47

markets

• markets: typeof MarketsService

Defined in: dfinance/index.ts:48

mint

• mint: typeof MintService

Defined in: dfinance/index.ts:49

multisig

• multisig: typeof MultisigService

Defined in: dfinance/index.ts:50

oracle

• oracle: typeof OracleService

Defined in: dfinance/index.ts:51

orders

• orders: typeof OrdersService

Defined in: dfinance/index.ts:52

poA

• poA: typeof PoAService

Defined in: dfinance/index.ts:53

slashing

• slashing: typeof SlashingService

Defined in: dfinance/index.ts:54

staking

• staking: typeof StakingService

Defined in: dfinance/index.ts:55

supply

• supply: typeof SupplyService

Defined in: dfinance/index.ts:56

tendermintRpc

• tendermintRpc: typeof TendermintRpcService

Defined in: dfinance/index.ts:57

transactions

• transactions: typeof TransactionsService

Defined in: dfinance/index.ts:58

vm

• vm: typeof VmService

Defined in: dfinance/index.ts:59

Methods

getConfigurations

▸ getConfigurations(method: any, contentType: string, url: string, configurations?: IRequestConfiguration): IRequestConfiguration

Parameters:

Name	Type
`method`	any
`contentType`	string
`url`	string
`configurations?`	IRequestConfiguration

Returns: IRequestConfiguration

Defined in: dfinance/index.ts:139

request

▸ request(configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: dfinance/index.ts:131

JSDK / dfinance/AuthService / AuthService

Class: AuthService

dfinance/AuthService.AuthService

Constructors

constructor

Properties

getConfigurations
request

Methods

getAuthAccountsAddress

Constructors

constructor

+ new AuthService(): AuthService

Returns: AuthService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: dfinance/rests/axios.ts:78

Defined in: dfinance/AuthService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: dfinance/rests/axios.ts:31

Defined in: dfinance/AuthService.ts:210

Methods

getAuthAccountsAddress

▸ StaticgetAuthAccountsAddress<Return>(parameters: { address: string }, options?: IRequestConfiguration): Promise<Return>

description Get the account information on blockchain

200 - Account information on the blockchain
500 - Server internel error

method getAuthAccountsAddress

see /auth/accounts/{address}

Type parameters:

Name	Default
`Return`	{ `type`: string ; `value`: { `account_number`: string ; `address`: string ; `coins`: Coin[] ; `public_key`: PublicKey ; `sequence`: string } }

Parameters:

Name	Type	Description
`parameters`	object
`parameters.address`	string	(in path) - Account address
`options?`	IRequestConfiguration

Returns: Promise<Return>

{Promise<{ type: string, value: { * account_number: string, * address: string, * coins: Coin[], * public_key: PublicKey, * sequence: string } }>}

Defined in: dfinance/AuthService.ts:238

JSDK / dfinance/BankService / BankService

Class: BankService

dfinance/BankService.BankService

Constructors

constructor

Properties

getConfigurations
request

Methods

getBankBalancesAddress
postBankAccountsAddressTransfers

Constructors

constructor

+ new BankService(): BankService

Returns: BankService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: dfinance/rests/axios.ts:78

Defined in: dfinance/BankService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: dfinance/rests/axios.ts:31

Defined in: dfinance/BankService.ts:210

Methods

getBankBalancesAddress

▸ StaticgetBankBalancesAddress<Return>(parameters: { address: string }, options?: IRequestConfiguration): Promise<Return>

description Get the account balances

200 - Account balances
500 - Server internal error

method getBankBalancesAddress

see /bank/balances/{address}

Type parameters:

Name	Default
`Return`	Coin[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.address`	string	(in path) - Account address in bech32 format
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/BankService.ts:270

postBankAccountsAddressTransfers

description Send coins from one account to another

202 - Tx was succesfully generated
400 - Invalid request
500 - Server internal error

method postBankAccountsAddressTransfers

see /bank/accounts/{address}/transfers

Type parameters:

Name	Default
`Return`	any

Parameters:

Name	Type	Description
`parameters`	object
`parameters.account`	object	-
`parameters.account.amount`	Coin[]	-
`parameters.account.base_req`	BaseReq	-
`parameters.address`	string	(in path) - Account address in bech32 format
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/BankService.ts:234

JSDK / dfinance/CurrenciesService / CurrenciesService

Class: CurrenciesService

dfinance/CurrenciesService.CurrenciesService

Constructors

constructor

Properties

getConfigurations
request

Methods

getCurrencies
getCurrenciesCurrencyDenom
getCurrenciesIssueIssueId
getCurrenciesWithdrawWithdrawId
getCurrenciesWithdraws
putCurrenciesIssue
putCurrenciesUnstake
putCurrenciesWithdraw

Constructors

constructor

+ new CurrenciesService(): CurrenciesService

Returns: CurrenciesService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: dfinance/rests/axios.ts:78

Defined in: dfinance/CurrenciesService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: dfinance/rests/axios.ts:31

Defined in: dfinance/CurrenciesService.ts:210

Methods

getCurrencies

▸ StaticgetCurrencies<Return>(options?: IRequestConfiguration): Promise<Return>

description Get all registered currencies

200 - OK
500 - Returned on server error

method getCurrencies

see /currencies

Type parameters:

Name	Default
`Return`	RestCcRespGetCurrencies

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/CurrenciesService.ts:227

getCurrenciesCurrencyDenom

▸ StaticgetCurrenciesCurrencyDenom<Return>(parameters: { denom: string }, options?: IRequestConfiguration): Promise<Return>

description Get currency

description Get currency by denom

200 - OK
500 - Returned on server error

method getCurrenciesCurrencyDenom

see /currencies/currency/{denom}

Type parameters:

Name	Default
`Return`	RestCcRespGetCurrency

Parameters:

Name	Type	Description
`parameters`	object
`parameters.denom`	string	(in path) - currency denomination symbol
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/CurrenciesService.ts:256

getCurrenciesIssueIssueId

▸ StaticgetCurrenciesIssueIssueId<Return>(parameters: { issueID: string }, options?: IRequestConfiguration): Promise<Return>

description Get currency issue

description Get currency issue by issueID

200 - OK
500 - Returned on server error

method getCurrenciesIssueIssueId

see /currencies/issue/{issueID}

Type parameters:

Name	Default
`Return`	RestCcRespGetIssue

Parameters:

Name	Type	Description
`parameters`	object
`parameters.issueID`	string	(in path) - issueID
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/CurrenciesService.ts:327

getCurrenciesWithdrawWithdrawId

▸ StaticgetCurrenciesWithdrawWithdrawId<Return>(parameters: { withdrawID: number }, options?: IRequestConfiguration): Promise<Return>

description Get currency withdraw

description Get currency withdraw by withdrawID

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getCurrenciesWithdrawWithdrawId

see /currencies/withdraw/{withdrawID}

Type parameters:

Name	Default
`Return`	RestCcRespGetWithdraw

Parameters:

Name	Type	Description
`parameters`	object
`parameters.withdrawID`	number	(in path) - withdrawID
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/CurrenciesService.ts:436

getCurrenciesWithdraws

▸ StaticgetCurrenciesWithdraws<Return>(parameters: { limit?: number ; page?: number }, options?: IRequestConfiguration): Promise<Return>

description Get currency withdraws

description Get array of Withdraw objects with pagination

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getCurrenciesWithdraws

see /currencies/withdraws

Type parameters:

Name	Default
`Return`	RestCcRespGetWithdraws

Parameters:

Name	Type	Description
`parameters`	object
`parameters.limit?`	number	(in query) - items per page (default: 100)
`parameters.page?`	number	(in query) - page number (first page: 1)
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/CurrenciesService.ts:472

putCurrenciesIssue

▸ StaticputCurrenciesIssue<Return>(parameters: { request: RestSubmitIssueReq }, options?: IRequestConfiguration): Promise<Return>

description Submit issue

description Get submit new issue multi signature message stdTx object

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method putCurrenciesIssue

see /currencies/issue

Type parameters:

Name	Default
`Return`	RestCcRespStdTx

Parameters:

Name	Type	Description
`parameters`	object
`parameters.request`	RestSubmitIssueReq	(in body) - Submit issue request
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/CurrenciesService.ts:291

putCurrenciesUnstake

▸ StaticputCurrenciesUnstake<Return>(parameters: { request: RestUnstakeReq }, options?: IRequestConfiguration): Promise<Return>

description Unstake tx

description Get new unstake multi signature message stdTx object

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method putCurrenciesUnstake

see /currencies/unstake

Type parameters:

Name	Default
`Return`	RestCcRespStdTx

Parameters:

Name	Type	Description
`parameters`	object
`parameters.request`	RestUnstakeReq	(in body) - Submit unstake request
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/CurrenciesService.ts:362

putCurrenciesWithdraw

▸ StaticputCurrenciesWithdraw<Return>(parameters: { request: RestWithdrawReq }, options?: IRequestConfiguration): Promise<Return>

description Withdraw currency

description Get withdraw currency coins from account balance stdTx object

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method putCurrenciesWithdraw

see /currencies/withdraw

Type parameters:

Name	Default
`Return`	RestCcRespStdTx

Parameters:

Name	Type	Description
`parameters`	object
`parameters.request`	RestWithdrawReq	(in body) - Withdraw request
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/CurrenciesService.ts:399

JSDK / dfinance/DistributionService / DistributionService

Class: DistributionService

dfinance/DistributionService.DistributionService

Constructors

constructor

Properties

getConfigurations
request

Methods

getDistributionCommunityPool
getDistributionDelegatorsDelegatorAddrRewards
getDistributionDelegatorsDelegatorAddrRewardsValidatorAddr
getDistributionDelegatorsDelegatorAddrWithdrawAddress
getDistributionParameters
getDistributionPoolPoolName
getDistributionValidatorExtendedValidatorAddr
getDistributionValidatorsExtended
getDistributionValidatorsValidatorAddr
getDistributionValidatorsValidatorAddrOutstandingRewards
getDistributionValidatorsValidatorAddrRewards
postDistributionDelegatorsDelegatorAddrRewards
postDistributionDelegatorsDelegatorAddrRewardsValidatorAddr
postDistributionDelegatorsDelegatorAddrWithdrawAddress
postDistributionPublicTreasuryPool
postDistributionValidatorsValidatorAddrRewards

Constructors

constructor

+ new DistributionService(): DistributionService

Returns: DistributionService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: boolean): IRequestConfiguration

Parameters:

Name	Type	Default value
`method`	Method	-
`contentType`	string	-
`url`	string	-
`configurations?`	IRequestConfiguration	-
`extendable`	boolean	true

Returns: IRequestConfiguration

Defined in: dfinance/rests/axios.ts:78

Defined in: dfinance/DistributionService.ts:211

request

▪ Static request: (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void) => Promise<any>

Type declaration:

▸ (configurations: IRequestConfiguration, resolve: (p: any) => void, reject: (p: any) => void): Promise<any>

Parameters:

Name	Type
`configurations`	IRequestConfiguration
`resolve`	(`p`: any) => void
`reject`	(`p`: any) => void

Returns: Promise<any>

Defined in: dfinance/rests/axios.ts:31

Defined in: dfinance/DistributionService.ts:210

Methods

getDistributionCommunityPool

▸ StaticgetDistributionCommunityPool<Return>(options?: IRequestConfiguration): Promise<Return>

description Community pool parameters

200 - OK
500 - Internal Server Error

method getDistributionCommunityPool

see /distribution/community_pool

Type parameters:

Name	Default
`Return`	Coin[]

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/DistributionService.ts:227

getDistributionDelegatorsDelegatorAddrRewards

▸ StaticgetDistributionDelegatorsDelegatorAddrRewards<Return>(parameters: { delegatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Get the total rewards balance from all delegations

description Get the sum of all the rewards earned by delegations by a single delegator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionDelegatorsDelegatorAddrRewards

see /distribution/delegators/{delegatorAddr}/rewards

Type parameters:

Name	Default
`Return`	RestQueryDelegatorRewardsResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/DistributionService.ts:257

getDistributionDelegatorsDelegatorAddrRewardsValidatorAddr

description Query a delegation reward

description Query a single delegation reward by a delegator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionDelegatorsDelegatorAddrRewardsValidatorAddr

see /distribution/delegators/{delegatorAddr}/rewards/{validatorAddr}

Type parameters:

Name	Default
`Return`	RestQueryDelegationRewardsResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`parameters.validatorAddr`	string	(in path) - Bech32 OperatorAddress of validator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/DistributionService.ts:338

getDistributionDelegatorsDelegatorAddrWithdrawAddress

▸ StaticgetDistributionDelegatorsDelegatorAddrWithdrawAddress<Return>(parameters: { delegatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Get the rewards withdrawal address

description Get the delegations' rewards withdrawal address. This is the address in which the user will receive the reward funds

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionDelegatorsDelegatorAddrWithdrawAddress

see /distribution/delegators/{delegatorAddr}/withdraw_address

Type parameters:

Name	Default
`Return`	RestQueryAddressResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/DistributionService.ts:419

getDistributionParameters

▸ StaticgetDistributionParameters<Return>(options?: IRequestConfiguration): Promise<Return>

description Fee distribution parameters

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionParameters

see /distribution/parameters

Type parameters:

Name	Default
`Return`	RestQueryParamsResp

Parameters:

Name	Type
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/DistributionService.ts:497

getDistributionPoolPoolName

▸ StaticgetDistributionPoolPoolName<Return>(parameters: { poolName: string }, options?: IRequestConfiguration): Promise<Return>

description Get the amount held in the specified pool

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionPoolPoolName

see /distribution/pool/{poolName}

Type parameters:

Name	Default
`Return`	RestQueryDecCoinsResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.poolName`	string	(in path) - PoolName: LiquidityProvidersPool, FoundationPool, PublicTreasuryPool, HARP
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/DistributionService.ts:529

getDistributionValidatorExtendedValidatorAddr

▸ StaticgetDistributionValidatorExtendedValidatorAddr<Return>(parameters: { validatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Query the extended information from a single validator

description Query the extended information from a single validator containing distribution params

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionValidatorExtendedValidatorAddr

see /distribution/validator_extended/{validatorAddr}

Type parameters:

Name	Default
`Return`	RestQueryExtendedValidatorResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.validatorAddr`	string	(in path) - Bech32 OperatorAddress of validator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/DistributionService.ts:601

getDistributionValidatorsExtended

▸ StaticgetDistributionValidatorsExtended<Return>(parameters: { limit?: string ; page?: string ; status?: string }, options?: IRequestConfiguration): Promise<Return>

description Query the extended information from multiple validators

description Query the extended information from multiple validators containing distribution params

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionValidatorsExtended

see /distribution/validators_extended

Type parameters:

Name	Default
`Return`	RestQueryExtendedValidatorsResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.limit?`	string	(in query) - The maximum number of items per page
`parameters.page?`	string	(in query) - The page number
`parameters.status?`	string	(in query) - The validator bond status. Must be either 'bonded', 'unbonded', or 'unbonding'
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/DistributionService.ts:797

getDistributionValidatorsValidatorAddr

▸ StaticgetDistributionValidatorsValidatorAddr<Return>(parameters: { validatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Validator distribution information

description Query the distribution information of a single validator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionValidatorsValidatorAddr

see /distribution/validators/{validatorAddr}

Type parameters:

Name	Default
`Return`	RestQuerySwaggerValidatorDistInfoResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.validatorAddr`	string	(in path) - Bech32 OperatorAddress of validator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/DistributionService.ts:639

getDistributionValidatorsValidatorAddrOutstandingRewards

▸ StaticgetDistributionValidatorsValidatorAddrOutstandingRewards<Return>(parameters: { validatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Fee distribution outstanding rewards of a single validator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionValidatorsValidatorAddrOutstandingRewards

see /distribution/validators/{validatorAddr}/outstanding_rewards

Type parameters:

Name	Default
`Return`	RestQueryDecCoinsResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.validatorAddr`	string	(in path) - Bech32 OperatorAddress of validator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/DistributionService.ts:677

getDistributionValidatorsValidatorAddrRewards

▸ StaticgetDistributionValidatorsValidatorAddrRewards<Return>(parameters: { validatorAddr: string }, options?: IRequestConfiguration): Promise<Return>

description Commission and self-delegation rewards of a single validator

description Query the commission and self-delegation rewards of validator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method getDistributionValidatorsValidatorAddrRewards

see /distribution/validators/{validatorAddr}/rewards

Type parameters:

Name	Default
`Return`	RestQueryDecCoinsResp

Parameters:

Name	Type	Description
`parameters`	object
`parameters.validatorAddr`	string	(in path) - Bech32 OperatorAddress of validator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/DistributionService.ts:715

postDistributionDelegatorsDelegatorAddrRewards

description Withdraw all the delegator's delegation rewards

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method postDistributionDelegatorsDelegatorAddrRewards

see /distribution/delegators/{delegatorAddr}/rewards

Type parameters:

Name	Default
`Return`	RestTxWithdrawDelegatorReward[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`parameters.postRequest`	RestWithdrawRewardsReq	(in body) - WithdrawRewardsReq request with signed transaction
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/DistributionService.ts:296

postDistributionDelegatorsDelegatorAddrRewardsValidatorAddr

description Withdraw a delegation reward

description Withdraw a delegator's delegation reward from a single validator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method postDistributionDelegatorsDelegatorAddrRewardsValidatorAddr

see /distribution/delegators/{delegatorAddr}/rewards/{validatorAddr}

Type parameters:

Name	Default
`Return`	RestTxWithdrawDelegatorReward[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`parameters.postRequest`	RestWithdrawRewardsReq	(in body) - WithdrawRewardsReq request with signed transaction
`parameters.validatorAddr`	string	(in path) - Bech32 OperatorAddress of validator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/DistributionService.ts:378

postDistributionDelegatorsDelegatorAddrWithdrawAddress

description Withdraw a delegation reward

description Withdraw a delegator's delegation reward from a single validator

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method postDistributionDelegatorsDelegatorAddrWithdrawAddress

see /distribution/delegators/{delegatorAddr}/withdraw_address

Type parameters:

Name	Default
`Return`	RestTxSetWithdrawAddress[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.delegatorAddr`	string	(in path) - Bech32 AccAddress of Delegator
`parameters.postRequest`	RestSetWithdrawalAddrReq	(in body) - SetWithdrawalAddrReq request with signed transaction
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/DistributionService.ts:458

postDistributionPublicTreasuryPool

▸ StaticpostDistributionPublicTreasuryPool<Return>(parameters: { postRequest: RestFundPublicTreasuryPoolReq }, options?: IRequestConfiguration): Promise<Return>

description Fund the public treasury pool

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method postDistributionPublicTreasuryPool

see /distribution/public_treasury_pool

Type parameters:

Name	Default
`Return`	RestTxFundPublicTreasuryPool[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.postRequest`	RestFundPublicTreasuryPoolReq	(in body) - FundPublicTreasuryPoolReq request with signed transaction
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/DistributionService.ts:564

postDistributionValidatorsValidatorAddrRewards

description Withdraw the validator's rewards

description Withdraw the validator's self-delegation and commissions rewards

200 - OK
400 - Returned if the request doesn't have valid query params
500 - Returned on server error

method postDistributionValidatorsValidatorAddrRewards

see /distribution/validators/{validatorAddr}/rewards

Type parameters:

Name	Default
`Return`	TypesStdTx[]

Parameters:

Name	Type	Description
`parameters`	object
`parameters.postRequest`	RestWithdrawRewardsReq	(in body) - WithdrawRewardsReq request with signed transaction
`parameters.validatorAddr`	string	(in path) - Bech32 OperatorAddress of validator
`options?`	IRequestConfiguration

Returns: Promise<Return>

Defined in: dfinance/DistributionService.ts:754

JSDK / dfinance/GovernanceService / GovernanceService

Class: GovernanceService

dfinance/GovernanceService.GovernanceService

Constructors

constructor

Properties

getConfigurations
request

Methods

getGovParametersDeposit
getGovParametersTallying
getGovParametersVoting
getGovProposals
getGovProposalsProposalId
getGovProposalsProposalIdDeposits
getGovProposalsProposalIdDepositsDepositor
getGovProposalsProposalIdProposer
getGovProposalsProposalIdTally
getGovProposalsProposalIdVotes
getGovProposalsProposalIdVotesVoter
postGovProposals
postGovProposalsParamChange
postGovProposalsProposalIdDeposits
postGovProposalsProposalIdVotes

Constructors

constructor

+ new GovernanceService(): GovernanceService

Returns: GovernanceService

Properties

getConfigurations

▪ Static getConfigurations: (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable: boolean) => IRequestConfiguration

Type declaration:

▸ (method: Method, contentType: string, url: string, configurations?: IRequestConfiguration, extendable?: *bool

dfin-jsdk

JSDK

Table of contents

Modules

Classes

Class: SDK

Table of contents

Constructors

Properties

Methods

Constructors

constructor

Parameters:

Properties

auth

bank

configurations

currencies

distribution

governance

markets

mint

multisig

oracle

orders

poA

slashing

staking

supply

tendermintRpc

transactions

vm

Methods

getConfigurations

Parameters:

request

Parameters:

Class: AuthService

Table of contents

Constructors

Properties

Methods

Constructors

constructor

Properties

getConfigurations

Type declaration:

Parameters:

request

Type declaration:

Parameters:

Methods

getAuthAccountsAddress

Type parameters:

Parameters:

Class: BankService

Table of contents

Constructors

Properties

Methods

Constructors

constructor

Properties

getConfigurations

Type declaration:

Parameters:

request

Type declaration:

Parameters:

Methods

getBankBalancesAddress

Type parameters:

Parameters:

postBankAccountsAddressTransfers

Type parameters:

Parameters:

Class: CurrenciesService

Table of contents

Constructors

Properties