Skip to content

Latest commit

 

History

History
211 lines (156 loc) · 7.84 KB

README.md

File metadata and controls

211 lines (156 loc) · 7.84 KB
Raw

Smart Invoice

Smart Invoice is an easy-to-use tool that empowers web3 freelancers with secure cryptocurrency invoicing, escrow services, and arbitration. Designed to streamline the payment process, Smart Invoice ensures that freelancers and clients can transact with confidence, knowing that funds are securely held in escrow until work is completed to satisfaction.

Features

  • Cryptocurrency Invoicing: Generate and send invoices directly in cryptocurrency, simplifying payments across borders.
  • Escrow Services: Funds are held securely in a smart contract until the agreed-upon work is completed.
  • Arbitration: In case of disputes, Smart Invoice provides an arbitration mechanism to ensure fair resolution.

Repository Structure

This project is organized as a pnpm monorepo, containing several packages to handle different aspects of the Smart Invoice protocol. Below is an overview of the key packages:

  • constants: Unified source for configs and constants used across the Smart Invoice protocol. npm package
  • contracts: Contains the smart contracts and contract interaction utilities that power Smart Invoice.
  • dapp: The decentralized application that provides the user interface for interacting with Smart Invoice.
  • docs: Documentation for the Smart Invoice protocol, including guides, API references, and usage instructions.
  • forms: Reusable form components for collecting and validating user input in the Smart Invoice dapp. npm package
  • graphql: GraphQL helpers and schema for querying and interacting with Smart Invoice data. npm package
  • hooks: A collection of React hooks for accessing and manipulating Smart Invoice states and effects. npm package
  • shared: Common utilities and components shared across multiple packages in the Smart Invoice ecosystem. npm package
  • subgraph: Subgraph for indexing and querying Smart Invoice events and data from the blockchain.
  • types: TypeScript types and interfaces used across the Smart Invoice monorepo for type safety and consistency. npm package
  • ui: Reusable UI components for integrating Smart Invoice functionalities into web applications. npm package
  • utils: A set of utility functions and helpers used throughout the Smart Invoice codebase. npm package

Installation

To get started with Smart Invoice, install the necessary dependencies using pnpm:

pnpm install

Using Smart Invoice Packages

Several packages in the Smart Invoice monorepo are published on npm and can be used directly in your project. Below are the installation commands for these packages:

  • constants: Install the constants package:

    pnpm add @smartinvoicexyz/constants

  • graphql: Install the GraphQL package:

    pnpm add @smartinvoicexyz/graphql

  • hooks: Install the React hooks package:

    pnpm add @smartinvoicexyz/hooks

  • utils: Install the utilities package:

    pnpm add @smartinvoicexyz/utils

  • types: Install the TypeScript types package:

    pnpm add @smartinvoicexyz/types

  • forms: Install the forms package:

    pnpm add @smartinvoicexyz/forms

  • ui: Install the ui package:

    pnpm add @smartinvoicexyz/ui

  • shared: Install the shared utilities and components package:

    pnpm add @smartinvoicexyz/shared

These packages can be integrated into your own projects to leverage the core functionalities of the Smart Invoice protocol.

Versioning

We follow Semantic Versioning for all packages in the Smart Invoice monorepo. To keep versions synchronized across packages, we use syncpack. After making changes and updating versions in package.json, you can ensure consistency by running:

pnpx syncpack fix-mismatches

This command checks for version mismatches and updates them across the monorepo to maintain alignment.

Managing Changes and Publishing with Changeset

Smart Invoice uses Changesets to manage versioning and publishing for the monorepo. Changesets provide a simple way to track changes to the various packages and ensure that proper versioning is applied before publishing updates.

Creating a Changeset

Whenever you make changes to any of the packages in the monorepo, you need to create a changeset to document those modifications. Use the following command to create a new changeset:

pnpm changeset

You will be prompted to select which packages are affected by the change, and what kind of version bump (major, minor, patch) is required.

After completing the prompt, a markdown file will be created in the .changeset folder, which details the changes made.

Committing and Reviewing Changesets

Once you've created a changeset, you can commit it to version control along with your code changes. Review the generated changeset markdown to ensure it correctly reflects the changes and intended version bumps.

Releasing New Versions

When you're ready to release new versions of your packages, run the following command to bump the versions in package.json files based on the changesets:

pnpm changeset version

This will update the package versions according to the changes you made in the .changeset folder.

Publishing to npm

Once the versions are bumped, you can publish the updated packages to npm using:

pnpm changeset publish

This command will publish all packages in the monorepo that have had changes, using the version bumps defined in the changeset.

Verifying Version Consistency

To ensure all package versions are synchronized and consistent across the monorepo, you can use syncpack as described in the Versioning section.

Metadata Schema Standard

All metadata uploaded to IPFS and saved as details in a Smart Invoice contract must adhere to the following schema:

{
  "version": "1.0",
  "id": "invoice-123",
  "title": "Web Development Services",
  "description": "Invoice for web development services provided in September.",
  "image": {
    "id": "image-001",
    "src": "https://example.com/image.png",
    "type": "https",
    "mimeType": "image/png",
    "createdAt": 1696800000
  },
  "documents": [
    {
      "id": "doc-001",
      "src": "ipfs://QmSomeHash",
      "type": "ipfs",
      "mimeType": "application/pdf",
      "createdAt": 1696800000
    },
    {
      "id": "doc-002",
      "src": "ar://arSomeHash",
      "type": "arweave",
      "mimeType": "application/pdf",
      "createdAt": 1696800500
    }
  ],
  "createdAt": 1696799600,
  "startDate": 1696540800,
  "endDate": 1699129200,
  "resolverType": "kleros",
  "klerosCourt": 1,
  "milestones": [
    {
      "id": "milestone-001",
      "title": "Phase 1 Completion",
      "description": "Completion of initial design phase.",
      "image": {
        "id": "image-001",
        "src": "https://example.com/image.png",
        "type": "https",
        "mimeType": "image/png",
        "createdAt": 1696800000
      },
      "documents": [
        {
          "id": "doc-003",
          "src": "https://example.com/phase1.pdf",
          "type": "https",
          "mimeType": "application/pdf",
          "createdAt": 1696800700
        }
      ],
      "createdAt": 1696800600,
      "endDate": 1697055600
    }
  ]
}

Community

Join our community on Discord for support, discussions, and updates about Smart Invoice.