Skip to content
This repository was archived by the owner on Jun 17, 2025. It is now read-only.
This repository was archived by the owner on Jun 17, 2025. It is now read-only.

Web Development SDK #6

@cmdruid

Description

@cmdruid

The web development SDK (or WSDK for short) is a planned upgrade to the escrow-core library.

The goal of the WSDK is to provide a friction-less experience in setting up an e-commerce website for offering your own escrow service, without any back-end server required.

The SDK will include the following main components:

  • DraftSession: Build, negotiate and endorse contract proposals using a peer-to-peer virtual private network. Powered by nostr and works in the browser.
  • usePaymentAddress: A useSWR hook for fetching payments from a blockchain oracle.
  • DepositAccount: Class interface for managing an account and registering a payment.
  • EscrowDeposit: Class interface for managing a registered deposit.
  • EscrowContract: Class interface for viewing and moderating a contract.
  • ContractVM: Class interface for monitoring and interacting with a contract's VM.

The negotiation phase of the protocol can be handled entirely over nostr via DraftSession. The remaining parts of the protocol will be handled by the escrow server.

If a web developer wishes to white-label our service, the WSDK should provide an out-of-box experience for setting up a static web-page, with their contract templates and signing credentials baked in.

This is a discussion thread for the WSDK project. Please feel free to discuss it here.

Metadata

Metadata

Assignees

Labels

roadmapDiscuss a topic from our Roadmap

Type

No type

Projects

Status

In Development

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions