Code Monkey home page Code Monkey logo

shorturlsolidity's Introduction

ShortUrlSolidity

  • An implementation of a Short Url service (REST API) using Node, Express, Solidity/Web3
  • Compiles contract with solc
  • Deployment is via Web3 (not using truffle)

You will need

To Run

  • Make sure you're running the latest version of node - node -v
  • Install ganache-cli globally - npm install -g ganache-cli
  • Install other dependencies in package.json - npm install
  • Have testrpc running in one terminal window - ganache-cli
  • In another terminal window run - node deployContract
  • Run node app

Endpoints - via http://localhost:3000

POST '/' - (Returns Shortened Url Key)

  • http://localhost:3000/
  • Send a JSON payload with a url property (ex. { "url": "www.google.com"})
  • This will return a url with the Shortened Url Key (ex. http://localhost:3000/UtFhjsP8)

GET '/:shortenedUrlKey' - (Redirects to corresponding URL)

  • Send a GET request with Shortened Url Key after slash
  • If using the key from the URL from the POST endpoint - http://localhost:3000/UtFhjsP8

Implementation

  • Hashing an original url via sha256
  • Encoding that hash to base64 and using the first 8 characters as the Shortened Url Key
  • (64^8 = 281,474,976,710,656 possible combinations)
  • Use recursive function to generate a new key if it already exists in storage in the contract
  • Store Shortened Url Keys as bytes8 in solidity contract and original url (undetermined length) as bytes

TODO

  • Implement tests

shorturlsolidity's People

Contributors

johnquiwacode avatar

Stargazers

Abhijith M S avatar

Watchers

James Cloos avatar John Quiwa avatar

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.