https://github.com/darwinia-network/darwinia.js

Darwinia JS SDK for dApp developers
https://github.com/darwinia-network/darwinia.js

Last synced: about 3 hours ago
JSON representation

Darwinia JS SDK for dApp developers

• Host: GitHub
• URL: https://github.com/darwinia-network/darwinia.js
• Owner: darwinia-network
• Created: 2022-11-30T08:40:14.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-21T10:18:08.000Z (5 months ago)
• Last Synced: 2024-11-07T21:45:03.423Z (5 days ago)
• Language: TypeScript
• Homepage:
• Size: 5.65 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# darwinia.js

Version >= ^3.0.2 for Darwinia 2.0. Version < 3.0.0 is for Darwinia 1.0.

A library to help

1. fetch internal substrate storages, and

2. dispatch calls

3. Easy-to-use derived functions([Derived API List](#derived-api-list)) which are build from 1 and 2.

## Nodejs

```shell

npm install darwinia.js@^3.2.0

```

NOTE:

- 3.1 changes:

  1. call returns `ethers.providers.TransactionResponse` instead of `ethers.providers.TransactionReceipt`.

- 3.2 changes:

  1. Removed pangolin and pangolin testnets.

  2. Removed pangolin tools.

  3. Added koi testnet.

## Browser

```html

storage(collatorCount): 


call(remarkWithEvemt): 

  import { ethers } from "https://esm.sh/[email protected]";

  import { clientBuilder } from "https://esm.sh/[email protected]";

  const provider = new ethers.providers.Web3Provider(window.ethereum);

  const client = clientBuilder.buildKoiClient(provider);

  // storage

  const collatorsCount = await client.storages.darwiniaStaking.collatorCount();

  const collatorsEl = document.getElementById("collators");

  collatorsEl.innerHTML = collatorsCount;

  // call

  await window.ethereum.request({ method: "eth_requestAccounts" });

  const signer = provider.getSigner();

  const tx = await client.calls.system.remarkWithEvent(signer, "0x12345678");

  const remarkEl = document.getElementById("remark");

  remarkEl.innerHTML = `<a href="https://koi-scan.darwinia.network/tx/${tx.hash}">${tx.hash}</a>`;

```

Try it in [jsfiddle](https://jsfiddle.net/wuminzhe/5qx0pcej/1/):

## Usage

### fetch storage

The returns of this lib's functions are all json string or null.

```typescript

import { ethers } from "ethers";

import { clientBuilder } from "darwinia.js";

async function main(): Promise {

  const provider = new ethers.providers.JsonRpcProvider(

    "https://koi-rpc.darwinia.network"

  );

  // or

  // const provider = new ethers.providers.Web3Provider(window.ethereum);

  const koi = clientBuilder.buildKoiClient(provider);

  let result = await koi.storages.system.account(

    "0x794BF0B66926D84CB735283D849f454A2A8d9a44"

  );

  console.log(`${result}\n`);

}

main();

```

### dispatch call

```typescript

import { ethers } from "ethers";

import { clientBuilder } from "darwinia.js";

async function main(): Promise {

  const provider = new ethers.providers.Web3Provider(window.ethereum);

  const signer = provider.getSigner();

  const koi = clientBuilder.buildKoiClient(provider);

  const tx = await koi.calls.session.setKeys(

    signer,

    {

      aura: "0xd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d",

    }, // keys

    "0x" // proof

  );

  console.log(`https://koi-scan.darwinia.network/tx/${tx.hash}`);

}

main();

```

### dispatch multiple calls in a single transaction

```typescript

import { ethers } from "ethers";

import { clientBuilder } from "darwinia.js";

async function main(): Promise {

  const provider = new ethers.providers.Web3Provider(window.ethereum);

  const signer = provider.getSigner();

  const koi = clientBuilder.buildKoiClient(provider);

  // prepare calls

  const setKeysCall = koi.calls.session.buildSetKeysCall(

    // keys

    {

      aura: "0xd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d",

    },

    // proof

    "px"

  );

  const collectCall = koi.calls.staking.buildCollectCall(120000000);

  // dispatch

  const tx = await koi.calls.utility.batchAll(signer, [

    setKeysCall,

    collectCall,

  ]);

  console.log(`https://koi-scan.darwinia.network/tx/${tx.hash}`);

}

main();

```

### dispatch call with encoded input

```typescript

import { ethers } from "ethers";

import { clientBuilder } from "darwinia.js";

async function main(): Promise {

  const provider = new ethers.providers.Web3Provider(window.ethereum);

  const signer = provider.getSigner();

  const koi = clientBuilder.buildKoiClient(provider);

  // call ended with `D` is the version that accept params encoded in scale codec

  const tx = await koi.calls.session.setKeysH(

    signer,

    "0xd43593c715fdd31c61141abd04a99fd6822c8558854ccde39a5684e7a56da27d00" // encoded (keys, proof)

  );

  console.log(`https://koi-scan.darwinia.network/tx/${tx.hash}`);

}

main();

```

More examples in [examples](https://github.com/darwinia-network/darwinia.js/tree/main/examples)

## Derived API List

#### nominateAndStake

Nominate a collator and stake tokens to the collator.

#### setSessionKeysAndCommission

Set session keys and commission percetage. [Example](https://github.com/darwinia-network/darwinia.js/tree/main/examples/derived_set_session_keys_and_commission.ts)

#### trackSystemEvents

Track specified events. [Example](https://github.com/darwinia-network/darwinia.js/tree/main/examples/derived_track_system_events.ts)

#### getSystemEvents

Get the latest events. You can use this function with `provider.on('block', callback)` to implement the tracking functionality like `trackSystemEvents`. [Example](https://github.com/darwinia-network/darwinia.js/tree/main/examples/derived_get_system_events.ts)

See [src/derived.ts](https://github.com/darwinia-network/darwinia.js/tree/main/src/derived.ts).

## Update Chains Metadata

```

npm run gen

```