npm install stridejs
⚡️ For web interfaces, we recommend using cosmos-kit. To sign and broadcast messages, you can create signers with a variety of options:
- cosmos-kit (recommended)
- keplr
- cosmjs
We recommend manually making the SigningStargateClient
instance yourself by using getSigningStrideClientOptions
:
import {
getSigningStrideClientOptions,
strideAccountParser,
} from "@stride/proto";
const { registry, aminoTypes } = getSigningStrideClientOptions();
const client = await SigningStargateClient.connectWithSigner(
rpc,
offlineSigner,
{
registry,
aminoTypes,
accountParser: accountFromAny,
}
);
We strongly recommend that you check the generated files in src/codegen/stride
and use it as source of truth for which functions you could use.
The rest of our documentation will cover only the tip of the iceberg — examples you can take ideas from.
import { stride } from "stridejs";
const client = await stride.ClienFactory.createRPCQueryClient({
rpcEndpoint: RPC_ENDPOINT,
});
const balance = await client.cosmos.bank.v1beta1.allBalances({
address: "stride1addresshere",
});
import { stride } from "stridejs";
const msgClaimFreeAmount =
stride.claim.MessageComposer.withTypeUrl.claimFreeAmount({
user: "stride1addresshere",
});
const fee = {
amount: [
{
amount: "0",
denom: "STRD",
},
],
gas: 250_000,
};
const tx = await strideAccount.client.signAndBroadcast(
"stride1addresshere",
[msgClaimFreeAmount],
fee,
""
);
assertIsDeliverTxSuccess(tx);
If you're unfamiliar with Stargate, you can read their guide here.
import { ibc } from "stridejs";
const { transfer } =
ibc.applications.transfer.v1.MessageComposer.withTypeUrl.transfer({
// Redacted (check internal types for the message parameters)
});
When first cloning the repo:
git submodule update --init
yarn
Update the generated ts files:
yarn codegen
Build the module and types:
yarn buidl
If you haven't logged to npm cli, run:
npm login
Afterwards, update package.json version.
# Example: <version> = v0.4.1
git tag <version>
git push origin <version>
git push origin main
npm publish
🛠 Built by Cosmology — if you like our tools, please consider delegating to our validator ⚛️
Code built with the help of these related projects:
- @cosmwasm/ts-codegen for generated CosmWasm contract Typescript classes
- @osmonauts/telescope a "babel for the Cosmos", Telescope is a TypeScript Transpiler for Cosmos Protobufs.
- cosmos-kit A wallet connector for the Cosmos ⚛️