@refractedlabs/oraclejs
v0.10.1
Published
Javascript SDK for Oracle
Downloads
1
Readme
OracleJS: Javascript SDK for refractedlabs/oracle
Install
pnpm install @refractedlabs/oraclejs
Usage
gRPC-web Clients
Import the refractedlabs
object from @refractedlabs/oraclejs
.
import { refractedlabs } from '@refractedlabs/oraclejs';
const client = await refractedlabs.ClientFactory.createGrpcWebClient({endpoint: GRPC_ENDPOINT});
// now you can query the oracle module
const params = await client.refractedlabs.oracle.v1.params();
// you can also query the cosmos modules
const balance = await client.cosmos.bank.v1beta1.allBalances({ address: 'refractedlabs1addresshere' });
Composing Messages
import { refractedlabs } from '@refractedlabs/oraclejs';
// oracle messages
const {
updateParams,
delegateFeedConsent,
oraclePreVote,
oracleVote,
oracleCombinedVote
} = refractedlabs.oracle.v1.MessageComposer.withTypeUrl;
Example Project
example is a sample project that depends on @refractedlabs/oraclejs
and contains example on how to query data or sign and send messages.
Connecting with Wallets and Signing Messages
⚡️ For web interfaces, we recommend using cosmos-kit. Continue below to see how to manually construct signers and clients.
Here are the docs on creating signers in cosmos-kit that can be used with Keplr and other wallets.
Initializing the Stargate Client
Use getSigningRefractedlabsClient
to get your SigningStargateClient
, with the proto/amino messages full-loaded. No need to manually add amino types, just require and initialize the client:
import { getSigningRefractedlabsClient } from '@refractedlabs/oraclejs';
const stargateClient = await getSigningRefractedlabsClient({
rpcEndpoint,
signer // OfflineSigner
});
Creating Signers
To broadcast messages, you can create signers with a variety of options:
- cosmos-kit (recommended)
- keplr
- cosmjs
Amino Signer
Likely you'll want to use the Amino, so unless you need proto, you should use this one:
import { getOfflineSignerAmino as getOfflineSigner } from 'cosmjs-utils';
Proto Signer
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.
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 === 'refractedlabs');
const signer = await getOfflineSigner({
mnemonic,
chain
});
Broadcasting Messages
Now that you have your stargateClient
, you can broadcast messages:
const { oraclePreVote } = refractedlabs.oracle.v1.MessageComposer.withTypeUrl;
const msg = oraclePreVote({
hash: "hash",
feeder: "feeder",
validator: "validator"
});
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
import { OfflineSigner, GeneratedType, Registry } from "@cosmjs/proto-signing";
import { AminoTypes, SigningStargateClient } from "@cosmjs/stargate";
import {
cosmosAminoConverters,
cosmosProtoRegistry,
cosmwasmAminoConverters,
cosmwasmProtoRegistry,
ibcProtoRegistry,
ibcAminoConverters,
refractedlabsAminoConverters,
refractedlabsProtoRegistry
} from '@refractedlabs/oraclejs';
const signer: OfflineSigner = /* create your signer (see above) */
const rpcEndpint = '<https://rpc.cosmos.directory/refractedlabs>'; // or another URL
const protoRegistry: ReadonlyArray<[string, GeneratedType]> = [
...cosmosProtoRegistry,
...cosmwasmProtoRegistry,
...ibcProtoRegistry,
...refractedlabsProtoRegistry
];
const aminoConverters = {
...cosmosAminoConverters,
...cosmwasmAminoConverters,
...ibcAminoConverters,
...refractedlabsAminoConverters
};
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:
pnpm install
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 @refractedlabs/oraclejs
:
pnpm codegen
Publishing
Build the types and then publish:
pnpm compile
pnpm publish
Credits
🛠 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 ⚛️