Skip to content

The beacon sdk allows developers of dApps and wallets on Tezos to implement the wallet interaction standard tzip-10.

License

Notifications You must be signed in to change notification settings

trilitech/beacon-sdk

 
 

Repository files navigation

Tezos SDK

Overview

Tezos SDK is a library designed to standardize the JSON RPC interface between dApps and wallets on the Tezos blockchain. This library contains all necessary interface definitions and utility functions to help developers build dApps and wallets with a well-defined, standard interface. It assists in creating JSON RPC messages in the correct format and validates received JSON RPC requests for syntactic correctness.

Features

  • Standardized JSON RPC interface definitions for Tezos dApps and wallets.
  • Utility functions to create and validate JSON RPC messages
  • Convenient to be used with WalletConnect
  • Comprehensive type definitions for various Tezos operations.

Installation

Using npm

npm install tezos-operations

Using yarn

yarn add tezos-operations

Usage

Importing the Library example

import { PartialTezosOperation } from 'tezos-operations/src/types/tezos';

Development

Cloning the Repository

git clone https://github.com/Trilitech/tezos-operations.git
cd tezos-operations

Installing Dependencies

yarn install

Building the Library

yarn build

Running Tests

yarn test

Contributing

We welcome contributions to the Tezos Operations library! Please follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some feature').
  5. Push to the branch (git push origin feature/your-feature).
  6. Create a new Pull Request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

For any questions or suggestions, please open an issue or submit a pull request.


Happy coding with Tezos!

About

The beacon sdk allows developers of dApps and wallets on Tezos to implement the wallet interaction standard tzip-10.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 83.1%
  • JavaScript 16.9%