Giter VIP home page Giter VIP logo

base58-solidity's Introduction

Base58 Solidity

Base58-Solidity

The first complete implementation of Base58 encode/decode in Solidity.

Github: https://github.com/storyicon/base58-solidity

Installation

npm install --save-dev base58-solidity

API

library Base58 {
    /**
    * @notice encode is used to encode the given bytes in base58 standard.
    * @param data_ raw data, passed in as bytes.
    * @return base58 encoded data_, returned as bytes.
    */
    function encode(bytes memory data_) public pure returns (bytes memory);
    /**
    * @notice decode is used to decode the given string in base58 standard.
    * @param data_ data encoded with base58, passed in as bytes.
    * @return raw data, returned as bytes.
    */
    function decode(bytes memory data_) public pure returns (bytes memory)
    /**
    * @notice encodeToString is used to encode the given byte in base58 standard.
    * @param data_ raw data, passed in as bytes.
    * @return base58 encoded data_, returned as a string.
    */
    function encodeToString(bytes memory data_) public pure returns (string memory)
    /**
    * @notice encodeFromString is used to encode the given string in base58 standard.
    * @param data_ raw data, passed in as a string.
    * @return base58 encoded data_, returned as bytes.
    */
    function encodeFromString(string memory data_) public pure returns (bytes memory)
    /**
    * @notice decode is used to decode the given string in base58 standard.
    * @param data_ data encoded with base58, passed in as string.
    * @return raw data, returned as bytes.
    */
    function decodeFromString(string memory data_) public pure returns (bytes memory)
}

Examples

// SPDX-License-Identifier: MIT
pragma solidity ^0.8.7;

import "base58-solidity/contracts/Base58.sol";

contract TestContract {
    // input: hello
    // output: Cn8eVZg
    function encode(string memory data_) public pure returns (string memory) {
        return string(Base58.encodeFromString(data_));
    }
    // input: Cn8eVZg
    // output: hello
    function decode(string memory data_) public pure returns (string memory) {
        return string(Base58.decodeFromString(data_));
    }
}

Contribution

Thank you for considering to help out with the source code! Welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!

If you'd like to contribute to this project, please fork, fix, commit and send a pull request for me to review and merge into the main code base.

License

This project is released under the MIT License.

base58-solidity's People

Contributors

storyicon avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

base58-solidity's Issues

Submitting this code to open zeppelin

Hi @storyicon

We would like to use this library in production.
As part of this effort we plan to audit the code.
but we are thinking we could also try to add it to open zeppelin repositories.

are you Ok with this ?
can we publish it on your behalf?
with minor fixes?

thanks

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.