@ark-us/wasmxjs 0.0.1

package/LICENSE

@@ -0,0 +1,3 @@
+Copyright (c) 2023 Loredana Cirstea <loredana.cirstea@gmail.com> - All Rights Reserved
+Unauthorized copying via any medium is strictly prohibited
+Proprietary and confidential

package/README.md

@@ -0,0 +1,280 @@
+# wasmxjs
+
+Typescript Protobuf Messages for Mythos
+
+
+## install
+
+```sh
+npm install @ark-us/wasmxjs
+```
+## Table of contents
+
+- [wasmxjs](#wasmxjs)
+  - [Install](#install)
+  - [Table of contents](#table-of-contents)
+- [Usage](#usage)
+    - [RPC Clients](#rpc-clients)
+    - [Composing Messages](#composing-messages)
+        - Cosmos, WasmX, and IBC
+            - [WasmX](#wasmx-messages)
+            - [IBC](#ibc-messages)
+            - [Cosmos](#cosmos-messages)
+- [Wallets and Signers](#connecting-with-wallets-and-signing-messages)
+    - [Stargate Client](#initializing-the-stargate-client)
+    - [Creating Signers](#creating-signers)
+    - [Broadcasting Messages](#broadcasting-messages)
+- [Advanced Usage](#advanced-usage)
+- [Developing](#developing)
+- [Credits](#credits)
+
+## Usage
+### RPC Clients
+
+```js
+import { mythos } from '@ark-us/wasmxjs';
+
+const { createRPCQueryClient } = mythos.ClientFactory;
+const client = await createRPCQueryClient({ rpcEndpoint: RPC_ENDPOINT });
+
+// now you can query the cosmos modules
+const balance = await client.cosmos.bank.v1beta1
+    .allBalances({ address: 'mythos1addresshere' });
+
+// you can also query the mythos modules
+const balances = await client.mythos.exchange.v1beta1
+    .exchangeBalances()
+```
+
+### Composing Messages
+
+Import the `mythos` object from `wasmxjs`.
+
+```js
+import { mythos } from '@ark-us/wasmxjs';
+
+const {
+    createSpotLimitOrder,
+    createSpotMarketOrder,
+    deposit
+} = mythos.exchange.v1beta1.MessageComposer.withTypeUrl;
+```
+
+#### WasmX Messages
+
+```js
+import { wasmx } from "@ark-us/wasmxjs";
+
+const {
+    executeContract,
+    instantiateContract,
+    storeCode,
+} = wasmx.wasmx.MessageComposer.withTypeUrl;
+```
+
+#### IBC Messages
+
+```js
+import { ibc } from '@ark-us/wasmxjs';
+
+const {
+    transfer
+} = ibc.applications.transfer.v1.MessageComposer.withTypeUrl
+```
+
+#### Cosmos Messages
+
+```js
+import { cosmos } from '@ark-us/wasmxjs';
+
+const {
+    fundCommunityPool,
+    setWithdrawAddress,
+    withdrawDelegatorReward,
+    withdrawValidatorCommission
+} = cosmos.distribution.v1beta1.MessageComposer.fromPartial;
+
+const {
+    multiSend,
+    send
+} = cosmos.bank.v1beta1.MessageComposer.fromPartial;
+
+const {
+    beginRedelegate,
+    createValidator,
+    delegate,
+    editValidator,
+    undelegate
+} = cosmos.staking.v1beta1.MessageComposer.fromPartial;
+
+const {
+    deposit,
+    submitProposal,
+    vote,
+    voteWeighted
+} = cosmos.gov.v1beta1.MessageComposer.fromPartial;
+```
+
+## Connecting with Wallets and Signing Messages
+
+⚡️ For web interfaces, we recommend using [cosmos-kit](https://github.com/cosmology-tech/cosmos-kit). Continue below to see how to manually construct signers and clients.
+
+Here are the docs on [creating signers](https://github.com/cosmology-tech/cosmos-kit/tree/main/packages/react#signing-clients) in cosmos-kit that can be used with Keplr and other wallets.
+
+### Initializing the Stargate Client
+
+Use `getSigningmythosClient` to get your `SigningStargateClient`, with the proto/amino messages full-loaded. No need to manually add amino types, just require and initialize the client:
+
+```js
+import { getSigningmythosClient } from '@ark-us/wasmxjs';
+
+const stargateClient = await getSigningmythosClient({
+  rpcEndpoint,
+  signer // OfflineSigner
+});
+```
+### Creating Signers
+
+To broadcast messages, you can create signers with a variety of options:
+
+* [cosmos-kit](https://github.com/cosmology-tech/cosmos-kit/tree/main/packages/react#signing-clients) (recommended)
+* [keplr](https://docs.keplr.app/api/cosmjs.html)
+* [cosmjs](https://gist.github.com/webmaster128/8444d42a7eceeda2544c8a59fbd7e1d9)
+### Amino Signer
+
+Likely you'll want to use the Amino, so unless you need proto, you should use this one:
+
+```js
+import { getOfflineSignerAmino as getOfflineSigner } from 'cosmjs-utils';
+```
+### Proto Signer
+
+```js
+import { getOfflineSignerProto as getOfflineSigner } from 'cosmjs-utils';
+```
+
+WARNING: NOT RECOMMENDED TO USE PLAIN-TEXT MNEMONICS. Please take care of your security and use best practices such as AES encryption and/or methods from 12factor applications.
+
+```js
+import { chains } from 'chain-registry';
+
+const mnemonic =
+  'unfold client turtle either pilot stock floor glow toward bullet car science';
+  const chain = chains.find(({ chain_name }) => chain_name === 'mythos');
+  const signer = await getOfflineSigner({
+    mnemonic,
+    chain
+  });
+```
+### Broadcasting Messages
+
+Now that you have your `stargateClient`, you can broadcast messages:
+
+```js
+const { send } = cosmos.bank.v1beta1.MessageComposer.withTypeUrl;
+
+const msg = send({
+    amount: [
+    {
+        denom: 'coin',
+        amount: '1000'
+    }
+    ],
+    toAddress: address,
+    fromAddress: address
+});
+
+const fee: StdFee = {
+    amount: [
+    {
+        denom: 'coin',
+        amount: '864'
+    }
+    ],
+    gas: '86364'
+};
+const response = await stargateClient.signAndBroadcast(address, [msg], fee);
+```
+
+## Advanced Usage
+
+
+If you want to manually construct a stargate client
+
+```js
+import { OfflineSigner, GeneratedType, Registry } from "@cosmjs/proto-signing";
+import { AminoTypes, SigningStargateClient } from "@cosmjs/stargate";
+
+import {
+    cosmosAminoConverters,
+    cosmosProtoRegistry,
+    wasmxAminoConverters,
+    wasmxProtoRegistry,
+    ibcProtoRegistry,
+    ibcAminoConverters,
+    mythosAminoConverters,
+    mythosProtoRegistry
+} from '@ark-us/wasmxjs';
+
+const signer: OfflineSigner = /* create your signer (see above)  */
+const rpcEndpint = 'https://rpc.cosmos.directory/mythos'; // or another URL
+
+const protoRegistry: ReadonlyArray<[string, GeneratedType]> = [
+    ...cosmosProtoRegistry,
+    ...wasmxProtoRegistry,
+    ...ibcProtoRegistry,
+    ...mythosProtoRegistry
+];
+
+const aminoConverters = {
+    ...cosmosAminoConverters,
+    ...wasmxAminoConverters,
+    ...ibcAminoConverters,
+    ...mythosAminoConverters
+};
+
+const registry = new Registry(protoRegistry);
+const aminoTypes = new AminoTypes(aminoConverters);
+
+const stargateClient = await SigningStargateClient.connectWithSigner(rpcEndpoint, signer, {
+    registry,
+    aminoTypes
+});
+```
+
+## Developing
+
+When first cloning the repo:
+
+```
+yarn
+yarn build
+```
+
+### Codegen
+
+Contract schemas live in `./contracts`, and protos in `./proto`. Look inside of `scripts/codegen.js` and configure the settings for bundling your SDK and contracts into `wasmxjs`:
+
+```
+yarn codegen
+```
+
+### Publishing
+
+Build the types and then publish:
+
+```
+yarn build:ts
+yarn publish
+```
+## Credits
+
+Code built with the help of these related projects:
+
+* [@osmonauts/telescope](https://github.com/osmosis-labs/telescope) a "babel for the Cosmos", Telescope is a TypeScript Transpiler for Cosmos Protobufs.
+
+## Disclaimer
+
+AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
+
+No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code or software using the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.