@cityofzion/neon-dappkit
v0.4.1
Published
<p align="center"> <img src="/.github/resources/images/coz.png" width="200px;"> </p>
Downloads
827
Keywords
Readme
Neon-DappKit
Neon-DappKit is the easiest way to build a dApp on Neo3. Suitable to connect Web Applications, Off-chain JS Servers and React-Native Apps to the Neo3 Blockchain.
WalletConnectSDK uses Neon-DappKit Types, so you can easily swap between Neon-DappKit implementation and WalletConnectSDK on the fly and reuse code, check the guide.
Installation
npm i @CityOfZion/neon-dappkit
In the vite.config.ts file you must change the global value like this:
export default defineConfig({
//your config here
define: {
global: 'globalThis',
//...
},
});
Getting Started
Neon-Dappkit has 4 main components:
- NeonInvoker: SmartContract Invocation Tool.
- NeonParser: Powerful Parser for Neo3 Types.
- NeonSigner: Signs, Verifies, Encrypts and Decrypts data.
- NeonEventListener: Listen to events from the Neo3 Blockchain.
Quick Example
import { NeonInvoker, NeonParser } from "@CityOfZion/neon-dappkit";
const invoker = await NeonInvoker.init({
rpcAddress: NeonInvoker.TESTNET,
})
const rawResp = await invoker.testInvoke({
invocations: [
{
scriptHash: '0x123456',
operation: 'myMethod',
args: [123, 'Test'].map(NeonParser.formatRpcArgument)
},
],
})
const resp = NeonParser.parseRpcResponse(rawResp.stack[0])