Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/layerx-labs/dappkit
A framework to build web3 dapps with javascript/typescript
https://github.com/layerx-labs/dappkit
blockchain dapp sdk solidity web3
Last synced: 3 months ago
JSON representation
A framework to build web3 dapps with javascript/typescript
- Host: GitHub
- URL: https://github.com/layerx-labs/dappkit
- Owner: layerx-labs
- License: isc
- Created: 2022-04-04T09:40:16.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-26T13:52:57.000Z (9 months ago)
- Last Synced: 2024-05-18T22:58:42.534Z (6 months ago)
- Topics: blockchain, dapp, sdk, solidity, web3
- Language: TypeScript
- Homepage: https://dappkit.dev
- Size: 14.5 MB
- Stars: 56
- Watchers: 7
- Forks: 23
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-web3-resources - dappkit
README
# dappkit
A javascript SDK for web3 projects with curated community contracts to ease development and interactions with blockchain contracts.
[](https://GitHub.com/taikai/dappkit/issues/)
[](https://opensource.org/licenses/ISC)
## Installation
```bash
$ npm install @taikai/dappkit
```
## Usage
```ts
import {ERC20} from '@taikai/dappkit';
const erc20 = new ERC20({ web3Host: process.env.WEB3_HOST_PROVIDER });
await erc20.connect(); // connect web3 by asking the user to allow the connection and interact with the chain
const tx =
await erc20Deployer.deployJsonAbi(
'Token Name', // the name of the token
'$tokenSymbol', // the symbol of the token
"1000000000000000000000000", // the total amount of the token (with 18 decimals; 1M = 1000000000000000000000000)
"0xOwnerOfErc20Address" // the owner of the total amount of the tokens (your address)
);
await erc20.transfer('0xYourOtherAddress', 1); // transfer 1 token from your address to other address
console.log(await erc20.balanceOf('0xYourOtherAddress')) // 1
```
### Just want to start a connection?
```ts
import {Web3Connection} from '@taikai/dappkit';
const web3Connection = new Web3Connection({web3Host: 'https://rpc.tld'});
await web3Connection.connect();
console.log(`Address`, await web3Connection.getAddress());
```
### Server side?
```ts
import {Web3Connection, Web3ConnectionOptions} from '@taikai/dappkit';
const web3ConnecitonOptions: Web3ConnectionOptions = {
web3Host: 'https://rpc.tld',
// no need to provide privateKey for read-only
privateKey: 'your-private-key', // never share your private key
}
const web3Connection = new Web3Connection(web3ConnecitonOptions);
console.log(`Address`, await web3Connection.getAddress());
```
## Documentation
* [Guides](https://docs.dappkit.dev/sdk-documentation/start-building/how-to-guides)
* [Advanced](./how-to/readme.md)
* [SDK Documentation](https://sdk.dappkit.dev/)
* [Use Cases](https://docs.dappkit.dev/sdk-documentation/use-cases)
Please refer to the [`test/`](./test/models) folder to read further usage examples of the various contracts available.
## Quick start
- [Node JS](https://stackblitz.com/edit/node-b3cgaa?file=index.js)
- [NextJs](https://stackblitz.com/edit/nextjs-nzulwe?file=pages/index.js)
- [Angular](https://github.com/taikai/dappkit-testflight)
### How to Generate Documentation
You can generate the documentation locally by issuing
```
$ npm run docs
```
and then serving the `docs/` folder as a root http-server.
## Contribution
Contributions are welcomed, but we ask that you read existing code guidelines, specially the code format.
Please review [Contributor guidelines](https://github.com/taikai/dappkit/blob/master/CONTRIBUTING.md)
## License
[ISC](./LICENSE.txt)
### Notes
- [Docker support](./docker-readme.md)
- [CoC](./CODE_OF_CONDUCT.md)
- [Dependencies](./DEPENDENCIES.md)