npm-publish

Provenance Blockchain API NPM publishing container

This repository contains the boilerplate Typescript transpiling code generated by telescope generate
(osmosis-labs/telescope) that is bundled into a docker image
provenanceio/npm-publish for use in the provenance CI release workflows.
It will transpile the provenance Protobuf API into Typescript and publish it as a module to NPM.

Note: this repository does not contain any generated sources.

install

``sh
npm install @provenanceio/provenance
`


Table of contents

- provenance
- Install
- Table of contents
- Usage
- RPC Clients
- Composing Messages
- Cosmos, CosmWasm, and IBC
- CosmWasm
- IBC
- Cosmos
- Wallets and Signers
- Stargate Client
- Creating Signers
- Broadcasting Messages
- Advanced Usage
- Developing
- Credits

Usage

$3

`js
import { provenance } from '@provenanceio/provenance';

const { createRPCQueryClient } = provenance.ClientFactory;
const client = await createRPCQueryClient({ rpcEndpoint: RPC_ENDPOINT });

// now you can query the cosmos modules
const balance = await client.cosmos.bank.v1beta1
.allBalances({ address: 'provenance1addresshere' });

// you can also query the provenance modules
const balances = await client.provenance.exchange.v1beta1
.exchangeBalances()
`

$3

Import the provenance object from @provenanceio/provenance.

`js
import { provenance } from '@provenanceio/provenance';

const {
createSpotLimitOrder,
createSpotMarketOrder,
deposit
} = provenance.exchange.v1beta1.MessageComposer.withTypeUrl;
`

#### CosmWasm Messages

`js
import { cosmwasm } from "@provenanceio/provenance";

const {
clearAdmin,
executeContract,
instantiateContract,
migrateContract,
storeCode,
updateAdmin
} = cosmwasm.wasm.v1.MessageComposer.withTypeUrl;
`

#### IBC Messages

`js
import { ibc } from '@provenanceio/provenance';

const {
transfer
} = ibc.applications.transfer.v1.MessageComposer.withTypeUrl
`

#### Cosmos Messages

`js
import { cosmos } from '@provenanceio/provenance';

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. 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.

$3

Use getSigningprovenanceClient 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 { getSigningprovenanceClient } from '@provenanceio/provenance';

const stargateClient = await getSigningprovenanceClient({
rpcEndpoint,
signer // OfflineSigner
});
`


$3

To broadcast messages, you can create signers with a variety of options:

* cosmos-kit (recommended)
* keplr
* cosmjs


$3

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';
`


$3

`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 === 'provenance');
const signer = await getOfflineSigner({
mnemonic,
chain
});
`


$3

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,
cosmwasmAminoConverters,
cosmwasmProtoRegistry,
ibcProtoRegistry,
ibcAminoConverters,
provenanceAminoConverters,
provenanceProtoRegistry
} from '@provenanceio/provenance';

const signer: OfflineSigner = / create your signer (see above) /
const rpcEndpint = 'https://rpc.cosmos.directory/provenance'; // or another URL

const protoRegistry: ReadonlyArray<[string, GeneratedType]> = [
...cosmosProtoRegistry,
...cosmwasmProtoRegistry,
...ibcProtoRegistry,
...provenanceProtoRegistry
];

const aminoConverters = {
...cosmosAminoConverters,
...cosmwasmAminoConverters,
...ibcAminoConverters,
...provenanceAminoConverters
};

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
`

$3

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 provenance:

`
yarn codegen
`

$3

Build the types and then publish:

`
yarn build:ts
yarn 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 ⚛️

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.