Skip to content

Applications and packages of the Tezos Payments service

License

Notifications You must be signed in to change notification settings

fastwaterbear/tezospayments

Repository files navigation

Tezos Payments

Homepage   •   Business   •   Docs   •   Demo - Payments   •   Demo - Donations   •   Contracts   •   Statuses ⬇️

⚠️ Tezos Payments is in active development so any component (application, contract, package, API) is subject to change ⚠️

Tezos Payments is a decentralized service that allows anyone to accept payments, donations, or send invoices using all advantages of the Tezos system. To use the service you don't need to register as with traditional services, just use the existing Tezos accounts.

Tezos Payments consists of two parts: smart contracts and applications for easy interaction with these contracts. This repository contains applications and related packages, the smart contracts is located here.

Key Components

  • Business Application. Web application for users who accepts payments or donations. Using this app the users can interact with the services factory contract for the creation of their own service contracts. Also, the app provides analytics and operations for all user services;
  • Payment Application. Web application for end-users (payers). This application provides a payment form that allows the end-user to view required information of a service, send payments or a donations using the current popular wallets, and review payment data that can be stored into a blockchain. This app is opened when end-users navigate by a payment URL generated by a service owner;
  • Service Smart Contract. Smart contract that reflects a user service. This contract contains service metadata (service name, description, link, etc.) and the method by which end-users can send payments and donations to the service owner;
  • Services Factory Smart Contract. Smart contract that creates service smart contracts for users.

Repository Structure

This repository is a monorepo of all applications and packages are located in the root directory:

tezospayments/
└── apps/
    ├── business-react-web
    ├── demo-shop-next-js
    ├── DemoShopAspNet
    ├── docs
    ├── landing
    └── payment-react-web
packages/
├── dotnet/
│   ├── TezosPayments
│   └── TezosPayments.Tests
└── js/
    ├── common
    ├── react-web-core
    └── tezospayments
apps. Contains all production and demo applications.
  • business-react-web. Web application.
    Usage: React, Ant Design, Redux Toolkit, Taquito, Beacon SDK, TypeScript;

  • demo-shop-next-js. Demo online store showing demo payments.
    Usage: Next.js, React, Typescript;

  • DemoShopAspNet. Demo online store showing demo payments.
    Usage: ASP.NET Core 6, Razor Pages, C#;

  • landing. Simple landing page for the tezospayments.com site;

  • docs. Site of the documentation;
    Usage: Docusaurus;

  • payment-react-web. Web application.
    Usage: React, Ant Design, Redux Toolkit, Taquito, Beacon SDK, TypeScript;

packages. Contains all related packages both public and internal.
  • dotnet. Packages for .NET;

    • TezosPayments. Public package for generating payments on .NET;

    • TezosPayments.Tests. Unit and integration tests for the TezosPayments package;

  • js. Packages for NodeJS and browsers;

    • common. Base packages for all js packages Shared code for the business app and the payment app;

    • react-web-core. Shared code for the business app and the payment app;

    • tezospayments. Public package for generating payments on the server and client sides;

Run Production Applications Locally

Prerequisites

  • Node.js version 16.7.0 or later
  • npm version 7.20.3 or later

Install dependencies

Open the root directory of the repository and launch the following command:

npm install

After all the dependencies are installed you can launch applications.

Business Application

Don't forget install the dependencies (see above).
Open the root directory of the repository and launch the following commands:

# Build the common package
npm run build -w @tezospayments/common

# Start the business-react-web application
npm run start -w @tezospayments/business-react-web

Payment Application

Don't forget install the dependencies (see above).
Open the root directory of the repository and launch the following commands:

# Build the common package
npm run build -w @tezospayments/common

# Start the payment-react-web application
npm run start -w @tezospayments/payment-react-web

Statuses ⬆️

Prod
apps/business-react-web apps/payment-react-web apps/landing apps/docs
packages/dotnet/tezospayments packages/js/tezospayments packages/js/common
apps/demo-shop-next-js apps/demo-shop-asp-net

Dev
apps/business-react-web apps/payment-react-web apps/landing apps/docs
packages/dotnet/tezospayments packages/js/tezospayments packages/js/common
apps/demo-shop-next-js apps/demo-shop-asp-net

Urls

Apps

Contracts