Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/setheum-js/setheum.js
Promise and RxJS APIs around Setheum Network Blockchain RPC calls.
https://github.com/setheum-js/setheum.js
api cross-chain defi ethereum evm javascript library rxjs setheum setheum-js setheum-network substrate typescript web3
Last synced: 27 days ago
JSON representation
Promise and RxJS APIs around Setheum Network Blockchain RPC calls.
- Host: GitHub
- URL: https://github.com/setheum-js/setheum.js
- Owner: setheum-js
- License: apache-2.0
- Created: 2021-05-13T05:36:20.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-04T03:23:09.000Z (almost 2 years ago)
- Last Synced: 2024-10-19T15:02:35.444Z (about 1 month ago)
- Topics: api, cross-chain, defi, ethereum, evm, javascript, library, rxjs, setheum, setheum-js, setheum-network, substrate, typescript, web3
- Language: TypeScript
- Homepage: https://setheum.js.org
- Size: 4.64 MB
- Stars: 2
- Watchers: 3
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.npmjs.com/package/@setheum.js/api)
# @setheum.js
Promise and RxJS APIs around Setheum RPC calls.
This library provides additional typing for users to access Setheum networks by using [setheum.js](https://github.com/setheum-js/api) using [polkadot.js](https://github.com/polkadot-js/api).
# Getting Started
More documentation and examples on [setheum.js.org](https://setheum.js.org).
1. Install dependencies
```bash
yarn add @polkadot/api @setheum.js/api
```
2. Create API instance
```ts
import { ApiPromise } from '@polkadot/api';
import { WsProvider } from '@polkadot/rpc-provider';
import { options } from '@setheum.js/api';
async function main() {
const provider = new WsProvider('wss://api.setheum.xyz');
const api = new ApiPromise(options({ provider }));
await api.isReady;
// use api
}
main()
```
3. Use api to interact with node
```ts
// query and display account data
const data = await api.query.system.account('5F98oWfz2r5rcRVnP9VCndg33DAAsky3iuoBSpaPUbgN9AJn');
console.log(data.toHuman())
```
## Types
- Use Setheum types
```ts
import {setheumDefs} from '@setheum-js/type-definitions';
// Define FileInfo
export type FileInfo = typeof setheumDefs.market.types.FileInfo;
// Use FileInfo as `interface`
```
## Packages Overview
The API is split up into a number of internal packages -
- [@setheum.js/api](packages/api/) The API library, providing both Promise and RxJS Observable-based interfaces. This is the main user-facing entry point.
- [@setheum.js/api-derive](packages/api-derive/) Additional polkadot.js derives for Setheum Network.
Derived results that are injected into the API, allowing for combinations of various query results (only used internally and exposed on the Api instances via `api.derive.*`).
- [@setheum.js/app-util](./packages/app-util)
- Utilities to work with Setheum.
- [@setheum.js/types](packages/types/) Codecs for all Polkadot.js type definations for Setheum primitives.
## Contribution
Please send a PR(Pull Request) to contribute this repo and read the following rules:
1. **No `--force` pushes** or modifying the master branch history in any way. If you need to rebase, ensure you do it in your own repo.
2. **Non-main branches**, prefixed with a short name moniker (e.g. zik/my-feature) must be used for ongoing work.
3. **All modifications** must be made in **pull-request** to solicit feedback from other contributors.
4. A pull-request **must not be merged until CI** has finished successfully.
5. Contributors should adhere to the [Google Typescript Style Guide](https://github.com/google/gts).