Git Product home page Git Product logo

arweavekit's Introduction

ArweaveKit

Introduction

ArweaveKit aims to lower the barrier of onboarding and building on Arweave by creating a well documented one-stop library.

Installation

Run the following command to install the package using npm or yarn

npm install arweavekit

#OR

yarn add arweavekit

Usage

Functions from specific function types can be imported as follows:

import { createWallet } from 'arweavekit/wallet';

const wallet = await createWallet({
  seedPhrase: true,
  environment: 'local',
});

Functions available

In this library, the following types of functions are available:

Wallet Functions: Functions associated with creating and using wallets. Read more here.

Transaction Functions: Functions associated with creating and interacting with transactions. Read more here.

Contract Functions: Functions associated with creating and interacting with contracts. Read more here.

Encryption Functions: Functions associated with encrypting and decrypting with encryption functions. Read more here.

Auth Functions: Functions associated with authentication. Authentication currently supports ArConnect only. Read more here.

Understanding the docs

Every function has a dedicated page with the following information associated with it:

  • Brief description of the function
  • Basic syntax for function calls
  • Input parameters for the function
    • Parameters with the optional keyword means they are optional. Parameters that do not have this keyword are required and must be passed in for successful function calls.
  • Returned data for function calls

Read the docs here

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.