![](\"./media/logo-light.svg#gh-light-mode-only\"){kind=logo}
\n ![](\"./media/logo-dark.svg#gh-dark-mode-only\"){kind=logo}
\n\n \n \n
\n The JavaScript SDK for Secret Network\n
\n\n\n ![\"npm\"](\"https://img.shields.io/npm/v/secretjs\")
![\"ci\"](\"https://github.com/scrtlabs/secret.js/actions/workflows/test.yml/badge.svg?branch=master\"){kind=icon}
\n
\n Explore the Docs »\n
\n\n GitHub »\n
\n\n![](\"./media/metamask-signing-example.jpg\")
\n\n## Keplr Wallet\n\nThe recommended way of integrating Keplr is by using `window.keplr.getOfflineSignerOnlyAmino()`:\n\n```ts\nimport { SecretNetworkClient } from \"secretjs\";\n\nconst sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));\n\nwhile (\n !window.keplr ||\n !window.getEnigmaUtils ||\n !window.getOfflineSignerOnlyAmino\n) {\n await sleep(50);\n}\n\nconst CHAIN_ID = \"secret-4\";\n\nawait window.keplr.enable(CHAIN_ID);\n\nconst keplrOfflineSigner = window.keplr.getOfflineSignerOnlyAmino(CHAIN_ID);\nconst [{ address: myAddress }] = await keplrOfflineSigner.getAccounts();\n\nconst url = \"TODO get from https://github.com/scrtlabs/api-registry\";\n\nconst secretjs = new SecretNetworkClient({\n url,\n chainId: CHAIN_ID,\n wallet: keplrOfflineSigner,\n walletAddress: myAddress,\n encryptionUtils: window.keplr.getEnigmaUtils(CHAIN_ID),\n});\n\n// Note: Using `window.getEnigmaUtils` is optional, it will allow\n// Keplr to use the same encryption seed across sessions for the account.\n// The benefit of this is that `secretjs.query.getTx()` will be able to decrypt\n// the response across sessions.\n```\n\nNotes:\n\n1. No mobile support yet.\n2. Keplr supports Ledger.\n3. By using `encryptionUtils` you let Keplr handle user encryption keys for you, which allows you to easily decrypt transactions across sessions.\n\nLinks:\n\n- Official Keplr Website »\n- Keplr API Docs »\n\n### `SignerOnlyAmino` vs `Signer` vs `SignerAuto`\n\nTLDR:\n\n- [`getOfflineSignerOnlyAmino()`](#getofflinesigneronlyamino): The recommended way. Supports Ledger, has a nice UI.\n- [`getOfflineSigner()`](#getofflinesigner): No Ledger support, ugly UI, can send IBC **relayer** txs and submit IBC gov proposals.\n- [`getOfflineSignerAuto()`](#getofflinesignerauto): If Ledger alias for `getOfflineSignerOnlyAmino()`, otherwise alias for `getOfflineSigner()`.\n\n#### `window.keplr.getOfflineSignerOnlyAmino()`\n\nAlthough this is the legacy way of signing transactions on cosmos-sdk, it's still the most recommended for connecting to Keplr due to Ledger support & better UI on Keplr.\n\n- 🟩 Looks good on Keplr\n- 🟩 Supports users signing with Ledger\n- 🟥 Doesn't support signing these transactions:\n - Every tx type under `ibc_client`, `ibc_connection` and `ibc_channel` (meaning IBC relaying, for example with [ts-relayer](https://github.com/confio/ts-relayer))\n - [gov/MsgSubmitProposal/ClientUpdateProposal](https://secretjs.scrt.network/enums/ProposalType#ClientUpdateProposal)\n - [gov/MsgSubmitProposal/UpgradeProposal](https://secretjs.scrt.network/enums/ProposalType#UpgradeProposal)\n\nNote that [ibc_transfer/MsgTransfer](https://secretjs.scrt.network/classes/MsgTransfer) for sending funds across IBC **is** supported.\n\n![](\"./media/keplr-amino.png\")
\n\n#### `window.keplr.getOfflineSigner()`\n\nThe new way of signing transactions on cosmos-sdk, it's more efficient but still doesn't have Ledger support, so it's most recommended for usage in apps that don't require signing transactions with Ledger.\n\n- 🟥 Looks bad on Keplr\n- 🟥 Doesn't support users signing with Ledger\n- 🟩 Supports signing transactions with all types of Msgs\n\n![](\"./media/keplr-proto.png\")
\n\n#### `window.keplr.getOfflineSignerAuto()`\n\nIf the connected Keplr account uses Ledger, returns `window.keplr.getOfflineSignerOnlyAmino()`. \nOtherwise returns `window.keplr.getOfflineSigner()`.\n\n## Fina Wallet\n\nFina implements the Keplr API, so [the above Keplr docs](#keplr-wallet) applies. If you support Keplr, your app will also work on the Fina Wallet mobile app. This works because the Fina Wallet mobile app has webview to which it injects its objects under `window.keplr`.\n\n### Deep linking\n\nFina supports deep linking into its in-app browser.\n\nExample1: `fina://wllet/dapps?network=secret-4&url=https%3A%2F%2Fdash.scrt.network`\n\nExample2:\n\nIf a user accessed your app using a regular mobile browser, you can open your app in the Fina in-app browser using this code:\n\n```ts\nconst urlSearchParams = new URLSearchParams();\nurlSearchParams.append(\"network\", \"secret-4\");\nurlSearchParams.append(\"url\", window.location.href);\n\nwindow.open(`fina://wllet/dapps?${urlSearchParams.toString()}`, \"_blank\");\n```\n\nLinks:\n\n- Official Fina Website »\n\n## Leap Cosmos Wallet\n\nThe recommended way of integrating Leap is by using `window.leap.getOfflineSignerOnlyAmino()`:\n\n```ts\nimport { SecretNetworkClient } from \"secretjs\";\n\nconst sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));\n\nwhile (\n !window.leap ||\n !window.leap.getEnigmaUtils ||\n !window.leap.getOfflineSignerOnlyAmino\n) {\n await sleep(50);\n}\n\nconst CHAIN_ID = \"secret-4\";\n\nawait window.leap.enable(CHAIN_ID);\n\nconst leapOfflineSigner = window.leap.getOfflineSignerOnlyAmino(CHAIN_ID);\nconst [{ address: myAddress }] = await leapOfflineSigner.getAccounts();\n\nconst url = \"TODO get from https://github.com/scrtlabs/api-registry\";\n\nconst secretjs = new SecretNetworkClient({\n url,\n chainId: CHAIN_ID,\n wallet: leapOfflineSigner,\n walletAddress: myAddress,\n encryptionUtils: window.leap.getEnigmaUtils(CHAIN_ID),\n});\n\n// Note: Using `window.leap.getEnigmaUtils()` is optional, it will allow\n// Leap to use the same encryption seed across sessions for the account.\n// The benefit of this is that `secretjs.query.getTx()` will be able to decrypt\n// the response across sessions.\n```\n\nLinks:\n\n- Official Leap Website »\n- Leap API Docs »\n\n## StarShell Wallet\n\nStarShell implements the Keplr API, so [the above Keplr docs](#keplr-wallet) applies. If you support Keplr, your app will also work on StarShell wallet. This works because StarShell wallet asks the user to turn off Keplr and then overrides `window.keplr` with its objects.\n\nLinks:\n\n- Official StarShell Website »\n\n# API\n\n## Wallet\n\nAn offline wallet implementation, used to sign transactions. Usually we'd just want to pass it to `SecretNetworkClient`.\n\n[**Full API »**](https://secretjs.scrt.network/classes/Wallet.html)\n\n### Importing account from mnemonic\n\n```ts\nimport { Wallet } from \"secretjs\";\n\nconst wallet = new Wallet(\n \"grant rice replace explain federal release fix clever romance raise often wild taxi quarter soccer fiber love must tape steak together observe swap guitar\",\n);\nconst myAddress = wallet.address;\n```\n\n### Generating a random account\n\n```ts\nimport { Wallet } from \"secretjs\";\n\nconst wallet = new Wallet();\nconst myAddress = wallet.address;\nconst myMnemonicPhrase = wallet.mnemonic;\n```\n\n## SecretNetworkClient\n\n[**Full API »**](https://secretjs.scrt.network/classes/SecretNetworkClient.html)\n\n### Querier secret.js\n\nA querier client can only send queries and get chain information. Access to all query types can be done via `secretjs.query`.\n\n```ts\nimport { SecretNetworkClient } from \"secretjs\";\n\nconst url = \"TODO get from https://github.com/scrtlabs/api-registry\";\n\n// To create a readonly secret.js client, just pass in a gRPC-web endpoint\nconst secretjs = new SecretNetworkClient({\n chainId: \"secret-4\",\n url,\n});\n```\n\n### Signer secret.js\n\nA signer client can broadcast transactions, send queries and get chain information.\n\nHere in addition to `secretjs.query`, there are also `secretjs.tx` & `secretjs.address`.\n\n```ts\nimport { Wallet, SecretNetworkClient, MsgSend, MsgMultiSend } from \"secretjs\";\n\nconst wallet = new Wallet(\n \"grant rice replace explain federal release fix clever romance raise often wild taxi quarter soccer fiber love must tape steak together observe swap guitar\",\n);\nconst myAddress = wallet.address;\n\nconst url = \"TODO get from https://github.com/scrtlabs/api-registry\";\n\n// To create a signer secret.js client you must also pass in `wallet`, `walletAddress` and `chainId`\nconst secretjs = new SecretNetworkClient({\n url,\n chainId: \"secret-4\",\n wallet: wallet,\n walletAddress: myAddress,\n});\n```\n\n### `secretjs.query`\n\n#### `secretjs.query.getTx(hash)`\n\nReturns a transaction with a txhash. `hash` is a 64 character upper-case hex string.\n\n#### `secretjs.query.txsQuery(query)`\n\nReturns all transactions that match a query.\n\nTo tell which events you want, you need to provide a query. query is a string, which has a form: `condition AND condition ...` (no OR at the moment). Condition has a form: `key operation operand`. key is a string with a restricted set of possible symbols (`\\t`, `\\n`, `\\r`, `\\`, `(`, `)`, `\"`, `'`, `=`, `>`, `<` are not allowed). Operation can be `=`, `<`, `<=`, `>`, `>=`, `CONTAINS` AND `EXISTS`. Operand can be a string (escaped with single quotes), number, date or time.\n\nExamples:\n\n- `tx.hash = 'XYZ'` # single transaction\n- `tx.height = 5` # all txs of the fifth block\n- `create_validator.validator = 'ABC'` # tx where validator ABC was created\n\nTendermint provides a few predefined keys: `tx.hash` and `tx.height`. You can provide additional event keys that were emitted during the transaction. All events are indexed by a composite key of the form `{eventType}.{evenAttrKey}`. Multiple event types with duplicate keys are allowed and are meant to categorize unique and distinct events.\n\nTo create a query for txs where AddrA transferred funds: `transfer.sender = 'AddrA'`\n\nSee `txsQuery` under https://secretjs.scrt.network/modules#Querier.\n\n#### `secretjs.query.auth.account()`\n\nReturns account details based on address.\n\n```ts\nconst { address, accountNumber, sequence } = await secretjs.query.auth.account({\n address: myAddress,\n});\n```\n\n#### `secretjs.query.auth.accounts()`\n\nReturns all existing accounts on the blockchain.\n\n```ts\n/// Get all accounts\nconst result = await secretjs.query.auth.accounts({});\n```\n\n#### `secretjs.query.auth.params()`\n\nQueries all x/auth parameters.\n\n```ts\nconst {\n params: {\n maxMemoCharacters,\n sigVerifyCostEd25519,\n sigVerifyCostSecp256k1,\n txSigLimit,\n txSizeCostPerByte,\n },\n} = await secretjs.query.auth.params();\n```\n\n#### `secretjs.query.authz.grants()`\n\nReturns list of authorizations, granted to the grantee by the granter.\n\n#### `secretjs.query.bank.balance()`\n\nBalance queries the balance of a single coin for a single account.\n\n```ts\nconst { balance } = await secretjs.query.bank.balance({\n address: myAddress,\n denom: \"uscrt\",\n});\n```\n\n#### `secretjs.query.bank.allBalances()`\n\nAllBalances queries the balance of all coins for a single account.\n\n#### `secretjs.query.bank.totalSupply()`\n\nTotalSupply queries the total supply of all coins.\n\n#### `secretjs.query.bank.supplyOf()`\n\nSupplyOf queries the supply of a single coin.\n\n#### `secretjs.query.bank.params()`\n\nParams queries the parameters of x/bank module.\n\n#### `secretjs.query.bank.denomMetadata()`\n\nDenomsMetadata queries the client metadata of a given coin denomination.\n\n#### `secretjs.query.bank.denomsMetadata()`\n\nDenomsMetadata queries the client metadata for all registered coin denominations.\n\n#### `secretjs.query.compute.codeHashByContractAddress()`\n\nGet codeHash of a Secret Contract.\n\n#### `secretjs.query.compute.codeHashByCodeId()`\n\nGet codeHash from a code id.\n\n#### `secretjs.query.compute.contractInfo()`\n\nGet metadata of a Secret Contract.\n\n#### `secretjs.query.compute.contractsByCode()`\n\nGet all contracts that were instantiated from a code id.\n\n#### `secretjs.query.compute.queryContract()`\n\nQuery a Secret Contract.\n\n```ts\ntype Result = {\n token_info: {\n decimals: number;\n name: string;\n symbol: string;\n total_supply: string;\n };\n};\n\nconst result = (await secretjs.query.compute.queryContract({\n contract_address: sScrtAddress,\n code_hash: sScrtCodeHash, // optional but way faster\n query: { token_info: {} },\n})) as Result;\n```\n\n#### `secretjs.query.compute.code()`\n\nGet WASM bytecode and metadata for a code id.\n\n```ts\nconst { codeInfo } = await secretjs.query.compute.code(codeId);\n```\n\n#### `secretjs.query.compute.codes()`\n\nQuery all contract codes on-chain.\n\n#### `secretjs.query.distribution.params()`\n\nParams queries params of the distribution module.\n\n#### `secretjs.query.distribution.validatorOutstandingRewards()`\n\nValidatorOutstandingRewards queries rewards of a validator address.\n\n#### `secretjs.query.distribution.validatorCommission()`\n\nValidatorCommission queries accumulated commission for a validator.\n\n#### `secretjs.query.distribution.validatorSlashes()`\n\nValidatorSlashes queries slash events of a validator.\n\n#### `secretjs.query.distribution.delegationRewards()`\n\nDelegationRewards queries the total rewards accrued by a delegation.\n\n#### `secretjs.query.distribution.delegationTotalRewards()`\n\nDelegationTotalRewards queries the total rewards accrued by a each validator.\n\n#### `secretjs.query.distribution.delegatorValidators()`\n\nDelegatorValidators queries the validators of a delegator.\n\n#### `secretjs.query.distribution.delegatorWithdrawAddress()`\n\nDelegatorWithdrawAddress queries withdraw address of a delegator.\n\n#### `secretjs.query.distribution.communityPool()`\n\nCommunityPool queries the community pool coins.\n\n#### `secretjs.query.distribution.foundationTax()`\n\nDelegatorWithdrawAddress queries withdraw address of a delegator.\n\n#### `secretjs.query.evidence.evidence()`\n\nEvidence queries evidence based on evidence hash.\n\n#### `secretjs.query.evidence.allEvidence()`\n\nAllEvidence queries all evidence.\n\n#### `secretjs.query.feegrant.allowance()`\n\nAllowance returns fee granted to the grantee by the granter.\n\n#### `secretjs.query.feegrant.allowances()`\n\nAllowances returns all the grants for address.\n\n#### `secretjs.query.gov.proposal()`\n\nProposal queries proposal details based on ProposalID.\n\n#### `secretjs.query.gov.proposals()`\n\nProposals queries all proposals based on given status.\n\n```ts\n// Get all proposals\nconst { proposals } = await secretjs.query.gov.proposals({\n proposal_status: ProposalStatus.PROPOSAL_STATUS_UNSPECIFIED,\n voter: \"\",\n depositor: \"\",\n});\n```\n\n#### `secretjs.query.gov.vote()`\n\nVote queries voted information based on proposalID, voterAddr.\n\n#### `secretjs.query.gov.votes()`\n\nVotes queries votes of a given proposal.\n\n#### `secretjs.query.gov.params()`\n\nParams queries all parameters of the gov module.\n\n#### `secretjs.query.gov.deposit()`\n\nDeposit queries single deposit information based proposalID, depositAddr.\n\n```ts\nconst {\n deposit: { amount },\n} = await secretjs.query.gov.deposit({\n depositor: myAddress,\n proposalId: propId,\n});\n```\n\n#### `secretjs.query.gov.deposits()`\n\nDeposits queries all deposits of a single proposal.\n\n#### `secretjs.query.gov.tallyResult()`\n\nTallyResult queries the tally of a proposal vote.\n\n#### `secretjs.query.ibc_channel.channel()`\n\nChannel queries an IBC Channel.\n\n#### `secretjs.query.ibc_channel.channels()`\n\nChannels queries all the IBC channels of a chain.\n\n#### `secretjs.query.ibc_channel.connectionChannels()`\n\nConnectionChannels queries all the channels associated with a connection end.\n\n#### `secretjs.query.ibc_channel.channelClientState()`\n\nChannelClientState queries for the client state for the channel associated with the provided channel identifiers.\n\n#### `secretjs.query.ibc_channel.channelConsensusState()`\n\nChannelConsensusState queries for the consensus state for the channel associated with the provided channel identifiers.\n\n#### `secretjs.query.ibc_channel.packetCommitment()`\n\nPacketCommitment queries a stored packet commitment hash.\n\n#### `secretjs.query.ibc_channel.packetCommitments()`\n\nPacketCommitments returns all the packet commitments hashes associated with a channel.\n\n#### `secretjs.query.ibc_channel.packetReceipt()`\n\nPacketReceipt queries if a given packet sequence has been received on the queried chain\n\n#### `secretjs.query.ibc_channel.packetAcknowledgement()`\n\nPacketAcknowledgement queries a stored packet acknowledgement hash.\n\n#### `secretjs.query.ibc_channel.packetAcknowledgements()`\n\nPacketAcknowledgements returns all the packet acknowledgements associated with a channel.\n\n#### `secretjs.query.ibc_channel.unreceivedPackets()`\n\nUnreceivedPackets returns all the unreceived IBC packets associated with a channel and sequences.\n\n#### `secretjs.query.ibc_channel.unreceivedAcks()`\n\nUnreceivedAcks returns all the unreceived IBC acknowledgements associated with a channel and sequences.\n\n#### `secretjs.query.ibc_channel.nextSequenceReceive()`\n\nNextSequenceReceive returns the next receive sequence for a given channel.\n\n#### `secretjs.query.ibc_client.clientState()`\n\nClientState queries an IBC light client.\n\n#### `secretjs.query.ibc_client.clientStates()`\n\nClientStates queries all the IBC light clients of a chain.\n\n#### `secretjs.query.ibc_client.consensusState()`\n\nConsensusState queries a consensus state associated with a client state at a given height.\n\n#### `secretjs.query.ibc_client.consensusStates()`\n\nConsensusStates queries all the consensus state associated with a given client.\n\n#### `secretjs.query.ibc_client.clientStatus()`\n\nStatus queries the status of an IBC client.\n\n#### `secretjs.query.ibc_client.clientParams()`\n\nClientParams queries all parameters of the ibc client.\n\n#### `secretjs.query.ibc_client.upgradedClientState()`\n\nUpgradedClientState queries an Upgraded IBC light client.\n\n#### `secretjs.query.ibc_client.upgradedConsensusState()`\n\nUpgradedConsensusState queries an Upgraded IBC consensus state.\n\n#### `secretjs.query.ibc_connection.connection()`\n\nConnection queries an IBC connection end.\n\n#### `secretjs.query.ibc_connection.connections()`\n\nConnections queries all the IBC connections of a chain.\n\n#### `secretjs.query.ibc_connection.clientConnections()`\n\nClientConnections queries the connection paths associated with a client state.\n\n#### `secretjs.query.ibc_connection.connectionClientState()`\n\nConnectionClientState queries the client state associated with the connection.\n\n#### `secretjs.query.ibc_connection.connectionConsensusState()`\n\nConnectionConsensusState queries the consensus state associated with the connection.\n\n#### `secretjs.query.ibc_transfer.denomTrace()`\n\nDenomTrace queries a denomination trace information.\n\n#### `secretjs.query.ibc_transfer.denomTraces()`\n\nDenomTraces queries all denomination traces.\n\n#### `secretjs.query.ibc_transfer.params()`\n\nParams queries all parameters of the ibc-transfer module.\n\n#### `secretjs.query.mint.params()`\n\nParams returns the total set of minting parameters.\n\n#### `secretjs.query.mint.inflation()`\n\nInflation returns the current minting inflation value.\n\n#### `secretjs.query.mint.annualProvisions()`\n\nAnnualProvisions current minting annual provisions value.\n\n#### `secretjs.query.params.params()`\n\nParams queries a specific parameter of a module, given its subspace and key.\n\n#### `secretjs.query.registration.txKey()`\n\nReturns the key used for transactions.\n\n#### `secretjs.query.registration.registrationKey()`\n\nReturns the key used for registration.\n\n#### `secretjs.query.registration.encryptedSeed()`\n\nReturns the encrypted seed for a registered node by public key.\n\n#### `secretjs.query.slashing.params()`\n\nParams queries the parameters of slashing module.\n\n#### `secretjs.query.slashing.signingInfo()`\n\nSigningInfo queries the signing info of given cons address.\n\n#### `secretjs.query.slashing.signingInfos()`\n\nSigningInfos queries signing info of all validators.\n\n#### `secretjs.query.staking.validators()`\n\nValidators queries all validators that match the given status.\n\n```ts\n// Get all validators\nconst { validators } = await secretjs.query.staking.validators({ status: \"\" });\n```\n\n#### `secretjs.query.staking.validator()`\n\nValidator queries validator info for given validator address.\n\n#### `secretjs.query.staking.validatorDelegations()`\n\nValidatorDelegations queries delegate info for given validator.\n\n#### `secretjs.query.staking.validatorUnbondingDelegations()`\n\nValidatorUnbondingDelegations queries unbonding delegations of a validator.\n\n#### `secretjs.query.staking.delegation()`\n\nDelegation queries delegate info for given validator delegator pair.\n\n#### `secretjs.query.staking.unbondingDelegation()`\n\nUnbondingDelegation queries unbonding info for given validator delegator pair.\n\n#### `secretjs.query.staking.delegatorDelegations()`\n\nDelegatorDelegations queries all delegations of a given delegator address.\n\n#### `secretjs.query.staking.delegatorUnbondingDelegations()`\n\nDelegatorUnbondingDelegations queries all unbonding delegations of a given delegator address.\n\n#### `secretjs.query.staking.redelegations()`\n\nRedelegations queries redelegations of given address.\n\n#### `secretjs.query.staking.delegatorValidators()`\n\nDelegatorValidators queries all validators info for given delegator address.\n\n#### `secretjs.query.staking.delegatorValidator()`\n\nDelegatorValidator queries validator info for given delegator validator pair.\n\n#### `secretjs.query.staking.historicalInfo()`\n\nHistoricalInfo queries the historical info for given height.\n\n#### `secretjs.query.staking.pool()`\n\nPool queries the pool info.\n\n#### `secretjs.query.staking.params()`\n\nParameters queries the staking parameters.\n\n#### `secretjs.query.tendermint.getNodeInfo()`\n\nGetNodeInfo queries the current node info.\n\n#### `secretjs.query.tendermint.getSyncing()`\n\nGetSyncing queries node syncing.\n\n#### `secretjs.query.tendermint.getLatestBlock()`\n\nGetLatestBlock returns the latest block.\n\n#### `secretjs.query.tendermint.getBlockByHeight()`\n\nGetBlockByHeight queries block for given height.\n\n#### `secretjs.query.tendermint.getLatestValidatorSet()`\n\nGetLatestValidatorSet queries latest validator-set.\n\n#### `secretjs.query.tendermint.getValidatorSetByHeight()`\n\nGetValidatorSetByHeight queries validator-set at a given height.\n\n#### `secretjs.query.upgrade.currentPlan()`\n\nCurrentPlan queries the current upgrade plan.\n\n#### `secretjs.query.upgrade.appliedPlan()`\n\nAppliedPlan queries a previously applied upgrade plan by its name.\n\n#### `secretjs.query.upgrade.upgradedConsensusState()`\n\nUpgradedConsensusState queries the consensus state that will serve as a trusted kernel for the next version of this chain. It will only be stored at the last height of this chain.\n\n#### `secretjs.query.upgrade.moduleVersions()`\n\nModuleVersions queries the list of module versions from state.\n\n### `secretjs.address`\n\nOn a signer secret.js, `secretjs.address` is the same as `walletAddress`:\n\n```ts\nimport { Wallet, SecretNetworkClient } from \"secretjs\";\n\nconst wallet = new Wallet(\n \"grant rice replace explain federal release fix clever romance raise often wild taxi quarter soccer fiber love must tape steak together observe swap guitar\",\n);\nconst myAddress = wallet.address;\n\nconst url = \"TODO get from https://github.com/scrtlabs/api-registry\";\n\n// To create a signer secret.js client, also pass in a wallet\nconst secretjs = new SecretNetworkClient({\n url,\n chainId: \"secret-4\",\n wallet: wallet,\n walletAddress: myAddress,\n});\n\nconst alsoMyAddress = secretjs.address;\n```\n\n### `secretjs.tx`\n\nOn a signer secret.js, `secretjs.tx` is used to broadcast transactions. Every function under `secretjs.tx` can receive an optional [TxOptions](https://secretjs.scrt.network/modules#TxOptions).\n\n[**Full API »**](https://secretjs.scrt.network/modules#TxSender)\n\n#### `secretjs.tx.broadcast()`\n\nUsed to send a complex transactions, which contains a list of messages. The messages are executed in sequence, and the transaction succeeds if all messages succeed.\n\nFor a list of all messages see: https://secretjs.scrt.network/interfaces/Msg\n\n```ts\nconst addMinterMsg = new MsgExecuteContract({\n sender: MY_ADDRESS,\n contract_address: MY_NFT_CONTRACT,\n code_hash: MY_NFT_CONTRACT_CODE_HASH, // optional but way faster\n msg: { add_minters: { minters: [MY_ADDRESS] } },\n sent_funds: [], // optional\n});\n\nconst mintMsg = new MsgExecuteContract({\n sender: MY_ADDRESS,\n contract_address: MY_NFT_CONTRACT,\n code_hash: MY_NFT_CONTRACT_CODE_HASH, // optional but way faster\n msg: {\n mint_nft: {\n token_id: \"1\",\n owner: MY_ADDRESS,\n public_metadata: {\n extension: {\n image: \"https://scrt.network/secretnetwork-logo-secondary-black.png\",\n name: \"secretnetwork-logo-secondary-black\",\n },\n },\n private_metadata: {\n extension: {\n image: \"https://scrt.network/secretnetwork-logo-primary-white.png\",\n name: \"secretnetwork-logo-primary-white\",\n },\n },\n },\n },\n sent_funds: [], // optional\n});\n\nconst tx = await secretjs.tx.broadcast([addMinterMsg, mintMsg], {\n gasLimit: 200_000,\n});\n```\n\n#### `secretjs.tx.simulate()`\n\nUsed to simulate a complex transactions, which contains a list of messages, without broadcasting it to the chain. Can be used to get a gas estimation or to see the output without actually committing a transaction on-chain.\n\nThe input should be exactly how you'd use it in `secretjs.tx.broadcast()`, except that you don't have to pass in `gasLimit`, `gasPriceInFeeDenom` & `feeDenom`.\n\nNotes:\n\n- :warning: On mainnet it's recommended to not simulate every transaction as this can burden your node provider. Instead, use this while testing to determine the gas limit for each of your app's transactions, then in production use hard-coded values.\n- Gas estimation is known to be a bit off, so you might need to adjust it a bit before broadcasting.\n- `MsgInstantiateContract` & `MsgExecuteContract` simulation is not supported for security reasons.\n\n```ts\nconst sendToAlice = new MsgSend({\n from_address: bob,\n to_address: alice,\n amount: stringToCoins(\"1uscrt\"),\n});\n\nconst sendToEve = new MsgSend({\n from_address: bob,\n to_address: eve,\n amount: stringToCoins(\"1uscrt\"),\n});\n\nconst sim = await secretjs.tx.simulate([sendToAlice, sendToEve]);\n\nconst tx = await secretjs.tx.broadcast([sendToAlice, sendToEve], {\n // Adjust gasLimit up by 10% to account for gas estimation error\n gasLimit: Math.ceil(sim.gasInfo.gasUsed * 1.1),\n});\n```\n\n#### `secretjs.tx.signTx()`\n\nUsed to sign transactions independently from the broadcast process. \nThis is useful when you want to keep your seed safe and sign transactions offline.\n\n#### `secretjs.tx.broadcastSignedTx()`\n\nUsed to send offline signed transactions.\n\n```ts\nconst bob = \"secret1dgqnta7fwjj6x9kusyz7n8vpl73l7wsm0gaamk\";\nconst msg = new MsgSend({\n from_address: myAddress,\n to_address: bob,\n amount: stringToCoins(\"1000000uscrt\"),\n});\n\nlet signedTX = await secretjs.tx.signTx([msg], {\n gasLimit: 20_000,\n gasPriceInFeeDenom: 0.1,\n feeDenom: \"uscrt\",\n});\n\nlet tx = await secretjs.tx.broadcastSignedTx(signedTX);\n```\n\n#### `secretjs.tx.authz.exec()`\n\nMsgExec attempts to execute the provided messages using authorizations granted to the grantee. Each message should have only one signer corresponding to the granter of the authorization.\n\nInput: [MsgExecParams](https://secretjs.scrt.network/interfaces/MsgExecParams)\n\n##### `secretjs.tx.authz.exec.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.authz.grant()`\n\nMsgGrant is a request type for Grant method. It declares authorization to the grantee on behalf of the granter with the provided expiration time.\n\nInput: [MsgGrantParams](https://secretjs.scrt.network/interfaces/MsgGrantParams)\n\n##### `secretjs.tx.authz.grant.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.authz.revoke()`\n\nMsgRevoke revokes any authorization with the provided sdk.Msg type on the granter's account with that has been granted to the grantee.\n\nInput: [MsgRevokeParams](https://secretjs.scrt.network/interfaces/MsgRevokeParams)\n\n##### `secretjs.tx.authz.revoke.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.bank.multiSend()`\n\nMsgMultiSend represents an arbitrary multi-in, multi-out send message.\n\nInput: [MsgMultiSendParams](https://secretjs.scrt.network/interfaces/MsgMultiSendParams)\n\n```ts\nconst tx = await secretjs.tx.bank.multiSend(\n {\n inputs: [\n {\n address: myAddress,\n coins: stringToCoins(\"2uscrt\"),\n },\n ],\n outputs: [\n {\n address: alice,\n coins: stringToCoins(\"1uscrt\"),\n },\n {\n address: bob,\n coins: stringToCoins(\"1uscrt\"),\n },\n ],\n },\n {\n gasLimit: 20_000,\n },\n);\n```\n\n ##### `secretjs.tx.bank.multiSend.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.bank.send()`\n\nMsgSend represents a message to send coins from one account to another.\n\nInput: [MsgSendParams](https://secretjs.scrt.network/interfaces/MsgSendParams)\n\n```ts\nconst tx = await secretjs.tx.bank.send(\n {\n from_address: myAddress,\n to_address: alice,\n amount: stringToCoins(\"1uscrt\"),\n },\n {\n gasLimit: 20_000,\n },\n);\n```\n\n##### `secretjs.tx.bank.send.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.compute.storeCode()`\n\nUpload a compiled contract to Secret Network\n\nInput: [MsgStoreCodeParams](https://secretjs.scrt.network/interfaces/MsgStoreCodeParams)\n\n```ts\nconst tx = await secretjs.tx.compute.storeCode(\n {\n sender: myAddress,\n wasm_byte_code: fs.readFileSync(\n `${__dirname}/snip20-ibc.wasm.gz`,\n ) as Uint8Array,\n source: \"\",\n builder: \"\",\n },\n {\n gasLimit: 1_000_000,\n },\n);\n\nconst codeId = Number(\n tx.arrayLog.find((log) => log.type === \"message\" && log.key === \"code_id\")\n .value,\n);\n```\n\n##### `secretjs.tx.compute.storeCode.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.compute.instantiateContract()`\n\nInstantiate a contract from code id\n\nInput: [MsgInstantiateContractParams](https://secretjs.scrt.network/interfaces/MsgInstanti\n\nateContractParams)\n\n```ts\nconst tx = await secretjs.tx.compute.instantiateContract(\n {\n sender: myAddress,\n code_id: codeId,\n code_hash: codeHash, // optional but way faster\n initMsg: {\n name: \"Secret SCRT\",\n admin: myAddress,\n symbol: \"SSCRT\",\n decimals: 6,\n initial_balances: [{ address: myAddress, amount: \"1\" }],\n prng_seed: \"eW8=\",\n config: {\n public_total_supply: true,\n enable_deposit: true,\n enable_redeem: true,\n enable_mint: false,\n enable_burn: false,\n },\n supported_denoms: [\"uscrt\"],\n },\n label: \"sSCRT\",\n init_funds: [], // optional\n },\n {\n gasLimit: 100_000,\n },\n);\n\nconst contractAddress = tx.arrayLog.find(\n (log) => log.type === \"message\" && log.key === \"contract_address\",\n).value;\n```\n\n##### `secretjs.tx.compute.instantiateContract.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\nWARNING: `secretjs.tx.compute.instantiateContract()` & `secretjs.tx.compute.executeContract()` simulation is not supported for security reasons.\n\n#### `secretjs.tx.compute.executeContract()`\n\nExecute a function on a contract\n\nInput: [MsgExecuteContractParams](https://secretjs.scrt.network/interfaces/MsgExecuteContractParams)\n\n```ts\nconst tx = await secretjs.tx.compute.executeContract(\n {\n sender: myAddress,\n contract_address: contractAddress,\n code_hash: codeHash, // optional but way faster\n msg: {\n transfer: {\n recipient: bob,\n amount: \"1\",\n },\n },\n sent_funds: [], // optional\n },\n {\n gasLimit: 100_000,\n },\n);\n```\n\n##### `secretjs.tx.compute.executeContract.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\nWARNING: `secretjs.tx.compute.instantiateContract()` & `secretjs.tx.compute.executeContract()` simulation is not supported for security reasons.\n\n#### `secretjs.tx.crisis.verifyInvariant()`\n\nMsgVerifyInvariant represents a message to verify a particular invariance.\n\nInput: [MsgVerifyInvariantParams](https://secretjs.scrt.network/interfaces/MsgVerifyInvariantParams)\n\n##### `secretjs.tx.crisis.verifyInvariant.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.distribution.fundCommunityPool()`\n\nMsgFundCommunityPool allows an account to directly fund the community pool.\n\nInput: [MsgFundCommunityPoolParams](https://secretjs.scrt.network/interfaces/MsgFundCommunityPoolParams)\n\n```ts\nconst tx = await secretjs.tx.distribution.fundCommunityPool(\n {\n depositor: myAddress,\n amount: stringToCoins(\"1uscrt\"),\n },\n {\n gasLimit: 20_000,\n },\n);\n```\n\n##### `secretjs.tx.distribution.fundCommunityPool.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.distribution.setWithdrawAddress()`\n\nMsgSetWithdrawAddress sets the withdraw address for a delegator (or validator self-delegation).\n\nInput: [MsgSetWithdrawAddressParams](https://secretjs.scrt.network/interfaces/MsgSetWithdrawAddressParams)\n\n```ts\nconst tx = await secretjs.tx.distribution.setWithdrawAddress(\n {\n delegator_address: mySelfDelegatorAddress,\n withdraw_address: myOtherAddress,\n },\n {\n gasLimit: 20_000,\n },\n);\n```\n\n##### `secretjs.tx.distribution.setWithdrawAddress.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.distribution.withdrawDelegatorReward()`\n\nMsgWithdrawDelegatorReward represents delegation withdrawal to a delegator from a single validator.\n\nInput: [MsgWithdrawDelegatorRewardParams](https://secretjs.scrt.network/interfaces/MsgWithdrawDelegatorRewardParams)\n\n```ts\nconst tx = await secretjs.tx.distribution.withdrawDelegatorReward(\n {\n delegator_address: myAddress,\n validator_address: someValidatorAddress,\n },\n {\n gasLimit: 20_000,\n },\n);\n```\n\n##### `secretjs.tx.distribution.withdrawDelegatorReward.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.distribution.withdrawValidatorCommission()`\n\nMsgWithdrawValidatorCommission withdraws the full commission to the validator address.\n\nInput: [MsgWithdrawValidatorCommissionParams](https://secretjs.scrt.network/interfaces/MsgWithdrawValidatorCommissionParams)\n\n```ts\nconst tx = await secretjs.tx.distribution.withdrawValidatorCommission(\n {\n validator_address: myValidatorAddress,\n },\n {\n gasLimit: 20_000,\n },\n);\n```\n\nOr a better one:\n\n```ts\nconst tx = await secretjs.tx.broadcast(\n [\n new MsgWithdrawDelegatorReward({\n delegator_address: mySelfDelegatorAddress,\n validator_address: myValidatorAddress,\n }),\n new MsgWithdrawValidatorCommission({\n validator_address: myValidatorAddress,\n }),\n ],\n {\n gasLimit: 30_000,\n },\n);\n```\n\n##### `secretjs.tx.distribution.withdrawValidatorCommission.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.evidence.submitEvidence()`\n\nMsgSubmitEvidence represents a message that supports submitting arbitrary evidence of misbehavior such as equivocation or counterfactual signing.\n\nInput: [MsgSubmitEvidenceParams](https://secretjs.scrt.network/interfaces/MsgSubmitEvidenceParams)\n\n##### `secretjs.tx.evidence.submitEvidence.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.feegrant.grantAllowance()`\n\nMsgGrantAllowance adds permission for Grantee to spend up to Allowance of fees from the account of Granter.\n\nInput: [MsgGrantAllowanceParams](https://secretjs.scrt.network/interfaces/MsgGrantAllowanceParams)\n\n```ts\nconst newWallet = new Wallet();\n\nconst txGranter = await secretjsGranter.tx.feegrant.grantAllowance({\n granter: secretjsGranter.address,\n grantee: newWallet.address,\n allowance: {\n spend_limit: stringToCoins(\"1000000uscrt\"),\n },\n});\n\nconst secretjsGrantee = new SecretNetworkClient({\n url: \"http://localhost:1317\",\n chainId: \"secretdev-1\",\n wallet: newWallet,\n walletAddress: newWallet.address,\n});\n\n// Send a tx from newWallet with secretjs.address as the fee payer\ncosnt txGrantee = await secretjsGrantee.tx.gov.submitProposal(\n {\n proposer: secretjsGrantee.address,\n type: ProposalType.TextProposal,\n initial_deposit: [],\n content: {\n title: \"Send a tx without any balance\",\n description: `Thanks ${secretjsGranter.address}!`,\n },\n },\n {\n feeGranter: secretjsGranter.address,\n },\n);\n```\n\n##### `secretjs.tx.feegrant.grantAllowance.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.feegrant.revokeAllowance()`\n\nMsgRevokeAllowance removes any existing Allowance from Granter to Grantee.\n\nInput: [MsgRevokeAllowanceParams](https://secretjs.scrt.network/interfaces/MsgRevokeAllowanceParams)\n\n```ts\nconst tx = await secretjs.tx.feegrant.revokeAllowance({\n granter: secretjs.address,\n grantee: newWallet.address,\n});\n```\n\n##### `secretjs.tx.feegrant.revokeAllowance.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.gov.deposit()`\n\nMsgDeposit defines a message to submit a deposit to an existing proposal.\n\nInput: [MsgDepositParams](https://secretjs.scrt.network/interfaces/MsgDepositParams)\n\n```ts\nconst tx = await secretjs.tx.gov.deposit(\n {\n depositor: myAddress,\n proposal_id: someProposalId,\n amount: stringToCoins(\"1uscrt\"),\n },\n {\n gasLimit: 20_000,\n },\n);\n```\n\n##### `secretjs.tx.gov.deposit.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.gov.submitProposal()`\n\nMsgSubmitProposal defines an sdk.Msg type that supports submitting arbitrary proposal Content.\n\nInput: [MsgSubmitProposalParams](https://secretjs.scrt.network/interfaces/MsgSubmitProposalParams)\n\n```ts\nconst tx = await secretjs.tx.gov.submitProposal(\n {\n type: ProposalType.TextProposal,\n proposer: myAddress,\n initial_deposit: stringToCoins(\"100000000uscrt\"),\n content: {\n title: \"Hi\",\n description: \"Let's vote on this\",\n },\n },\n {\n gasLimit: 50_000,\n },\n);\n\nconst proposalId = Number(\n tx.arrayLog.find(\n (log) => log.type === \"submit_proposal\" && log.key === \"proposal_id\",\n ).value,\n);\n```\n\n##### `secretjs.tx.gov.submitProposal.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.gov.vote()`\n\nMsgVote defines a message to cast a vote.\n\nInput: [MsgVoteParams](https://secretjs.scrt.network/interfaces/MsgVoteParams)\n\n```ts\nconst tx = await secretjs.tx.gov.vote(\n {\n voter: myAddress,\n proposal_id: someProposalId,\n option: VoteOption.VOTE_OPTION_YES,\n },\n {\n gasLimit: 50_000,\n },\n);\n```\n\n##### `secretjs.tx.gov.vote.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.gov.voteWeighted()`\n\nMsgVoteWeighted defines a message to cast a vote, with an option to split the vote.\n\nInput: [MsgVoteWeightedParams](https://secretjs.scrt.network/interfaces/MsgVoteWeightedParams)\n\n```ts\n// vote yes with 70% of my power\nconst tx = await secretjs.tx.gov.voteWeighted(\n {\n voter: myAddress,\n proposal_id: someProposalId,\n options: [\n // weights must sum to 1.0\n { weight: 0.7, option: VoteOption.VOTE_OPTION_YES },\n { weight: 0.3, option: VoteOption.VOTE_OPTION_ABSTAIN },\n ],\n },\n {\n gasLimit: 50_000,\n },\n);\n```\n\n##### `secretjs.tx.gov.voteWeighted.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.ibc.transfer()`\n\nMsgTransfer defines a msg to transfer fungible tokens (i.e Coins) between ICS20 enabled chains. See ICS Spec here: https://github.com/cosmos/ics/tree/master/spec/ics-020-fungible-token-transfer#data-structures\n\nInput: [MsgTransferParams](https://secretjs.scrt.network/interfaces/MsgTransferParams)\n\n##### `secretjs.tx.ibc.transfer.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.slashing.unjail()`\n\nMsgUnjail defines a message to release a validator from jail.\n\nInput: [MsgUnjailParams](https://secretjs.scrt.network/interfaces/MsgUnjailParams)\n\n```ts\nconst tx = await secretjs.tx.slashing.unjail(\n {\n validator_addr: mValidatorsAddress,\n },\n {\n gasLimit: 50_000,\n },\n);\n```\n\n##### `secretjs.tx.slashing.unjail.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.staking.beginRedelegate()`\n\nMsgBeginRedelegate defines an SDK message for performing a redelegation of coins from a delegator and source validator to a destination validator.\n\nInput: [MsgBeginRedelegateParams](https://secretjs.scrt.network/interfaces/MsgBeginRedelegateParams)\n\n```ts\nconst tx = await secretjs.tx.staking.beginRedelegate(\n {\n delegator_address: myAddress,\n validator_src_address: someValidator,\n validator_dst_address: someOtherValidator,\n amount: stringToCoin(\"1uscrt\"),\n },\n {\n gasLimit: 50_000,\n },\n);\n```\n\n##### `secretjs.tx.staking.beginRedelegate.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.staking.createValidator()`\n\nMsgCreateValidator defines an SDK message for creating a new validator.\n\nInput: [MsgCreateValidatorParams](https://secretjs.scrt.network/interfaces/MsgCreateValidatorParams)\n\n```ts\nconst tx = await secretjs.tx.staking.createValidator(\n {\n delegator_address: myAddress,\n commission: {\n max_change_rate: 0.01, // can change +-1% every 24h\n max_rate: 0.1, // 10%\n rate: 0.05, // 5%\n },\n description: {\n moniker: \"My validator's display name\",\n identity: \"ID on keybase.io, to have a logo on explorer and stuff\",\n website: \"example.com\",\n security_contact: \"hi@example.com\",\n details: \"**We** are good\",\n },\n pubkey: toBase64(new Uint8Array(32).fill(1)), // validator's pubkey, to sign on validated blocks\n min_self_delegation: \"1\", // uscrt\n initial_delegation: stringToCoin(\"1uscrt\"),\n },\n {\n gasLimit: 100_000,\n },\n);\n```\n\n##### `secretjs.tx.staking.createValidator.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.staking.delegate()`\n\nMsgDelegate defines an SDK message for performing a delegation of coins from a delegator to a validator.\n\nInput: [MsgDelegateParams](https://secretjs.scrt.network/interfaces/MsgDelegateParams)\n\n```ts\nconst tx = await secretjs.tx.staking.delegate(\n {\n delegator_address: myAddress,\n validator_address: someValidatorAddress,\n amount: stringToCoin(\"1uscrt\"),\n },\n {\n gasLimit: 50_000,\n },\n);\n```\n\n##### `secretjs.tx.staking.delegate.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.staking.editValidator()`\n\nMsgEditValidator defines an SDK message for editing an existing validator.\n\nInput: [MsgEditValidatorParams](https://secretjs.scrt.network/interfaces/MsgEditValidatorParams)\n\n```ts\nconst tx = await secretjs.tx.staking.editValidator(\n {\n validator_address: myValidatorAddress,\n description: {\n // To edit even one item in \"description you have to re-input everything\n moniker: \"papaya\",\n identity: \"banana\",\n website: \"watermelon.com\",\n security_contact: \"sec@watermelon.com\",\n details: \"We are the banana papaya validator yay!\",\n },\n min_self_delegation: \"2\",\n commission_rate: 0.04, // 4%, commission cannot be changed more than once in 24h\n },\n {\n gasLimit: 5_000_000,\n },\n);\n```\n\n##### `secretjs.tx.staking.editValidator.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n#### `secretjs.tx.staking.undelegate()`\n\nMsgUndelegate defines an SDK message for performing an undelegation from a delegate and a validator\n\nInput: [MsgUndelegateParams](https://secretjs.scrt.network/interfaces/MsgUndelegateParams)\n\n```ts\nconst tx = await secretjs.tx.staking.undelegate(\n {\n delegator_address: myAddress,\n validator_address: someValidatorAddress,\n amount: stringToCoin(\"1uscrt\"),\n },\n {\n gasLimit: 50_000,\n },\n);\n```\n\n##### `secretjs.tx.staking.undelegate.simulate()`\n\nSimulates execution without sending a transactions. Input is exactly like the parent function. For more info see [`secretjs.tx.simulate()`](#secretjstxsimulate).\n\n### Resolve IBC Responses\n\nIf a tx that was sent using secret.js resulted in IBC packets being sent to other chains, secret.js will resolve the IBC response (ack or timeout) inside `TxResponse`.\n\n```ts\nimport { Wallet, SecretNetworkClient } from \"secretjs\";\n\nconst wallet = new Wallet(\n \"grant rice replace explain federal release fix clever romance raise often wild taxi quarter soccer fiber love must tape steak together observe swap guitar\",\n);\n\nconst osmoAddress = new Wallet(\n \"grant rice replace explain federal release fix clever romance raise often wild taxi quarter soccer fiber love must tape steak together observe swap guitar\",\n {\n bech32Prefix: \"osmos\",\n coinType: 118,\n },\n).address;\n\nconst secretjs = new SecretNetworkClient({\n url: \"http://localhost:1317\",\n chainId: \"secretdev-1\",\n wallet,\n walletAddress: wallet.address,\n});\n\nconst tx = await secretjs.tx.ibc.transfer(\n {\n sender: wallet.address,\n receiver: osmoAddress,\n source_channel: \"channel-1\",\n source_port: \"transfer\",\n token: stringToCoin(\"1uscrt\"),\n timeout_timestamp: String(Math.floor(Date.now() / 1000) + 10 * 60), // 10 minutes\n },\n {\n gasLimit: 100_000,\n ibcTxsOptions: {\n resolveResponses: true, // enable IBC responses resolution (defualt)\n resolveResponsesTimeoutMs: 12 * 60 * 1000, // stop checking after 12 minutes (default is 2 minutes)\n resolveResponsesCheckIntervalMs: 15_000, // check every 15 seconds (default)\n },\n },\n);\n\nif (tx.code !== 0) {\n console.error(\"failed sending 1uscrt from Secret to Osmosis:\", tx.rawLog);\n} else {\n try {\n const ibcResp = await tx.ibcResponses[0];\n if (ibcResp.type === \"ack\") {\n console.log(\"successfuly sent 1uscrt from Secret to Osmosis!\");\n } else {\n console.error(\n \"failed sending 1uscrt from Secret to Osmosis: IBC packet timed-out before committed on Osmosis\",\n );\n }\n } catch (_error) {\n console.error(\n `timed-out while trying to resolve IBC response for txhash ${tx.transactionHash}`,\n );\n }\n}\n```\n\n## Helper Functions\n\n### `pubkeyToAddress()`\n\nConvert a secp256k1 compressed public key to an account address.\n\nhttps://secretjs.scrt.network/modules#pubkeyToAddress\n\n### `base64PubkeyToAddress()`\n\nConvert a secp256k1 compressed base64 encoded public key to an account address.\n\nhttps://secretjs.scrt.network/modules#base64PubkeyToAddress\n\n### `selfDelegatorAddressToValidatorAddress()`\n\nConvert a self delegator address to a validator address.\n\nhttps://secretjs.scrt.network/modules#selfDelegatorAddressToValidatorAddress\n\n### `validatorAddressToSelfDelegatorAddress()`\n\nConvert a validator address to a self delegator address.\n\nhttps://secretjs.scrt.network/modules#validatorAddressToSelfDelegatorAddress\n\n### `tendermintPubkeyToValconsAddress()`\n\nConvert a Tendermint ed25519 public key to a consensus address.\n\nhttps://secretjs.scrt.network/modules#tendermintPubkeyToValconsAddress\n\n### `base64TendermintPubkeyToValconsAddress()`\n\nConvert a secp256k1 compressed public key to an account address.\n\nhttps://secretjs.scrt.network/modules#base64TendermintPubkeyToValconsAddress\n\n### `ibcDenom()`\n\nCompute the IBC denom of a token that was sent over IBC.\n\nhttps://secretjs.scrt.network/modules#ibcDenom\n\n### `stringToCoins()` / `coinsFromString()`\n\nE.g.\nconvert `\"1uscrt,1uatom,1uosmo\"`\ninto `[{amount:\"1\",denom:\"uscrt\"}, {amount:\"1\",denom:\"uatom\"}, {amount:\"1\",denom:\"uosmo\"}]`\n\nhttps://secretjs.scrt.network/modules#stringToCoins\n\n### `stringToCoins()` / `coinFromString()`\n\nE.g.\nconvert `\"1uscrt,1uatom,1uosmo\"`\ninto `[{amount:\"1\",denom:\"uscrt\"}, {amount:\"1\",denom:\"uatom\"}, {amount:\"1\",denom:\"uosmo\"}]`\n\nhttps://secretjs.scrt.network/modules#stringToCoins\n\n### `validateAddress()`\n\nChecks if a given address is a valid address.\n\nhttps://secretjs.scrt.network/modules#validateAddress\n","readmeFilename":"README.md"}