Skip to content

Latest commit

Β 

History

21 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

GOT

Global onchain transfers infrastructure.

Make global onchain transfers simple.

GOT is open infrastructure for creating and resolving onchain transfer destinations. got.cx builds on GOT to provide simple transfer experiences for users, businesses, apps, and developers.

Understand GOT

Vision πŸ‘€

Global Onchain Transfers for Everyone.

Mission 🎯

Make global onchain transfers simple.

GOT protocol 🌐

Global onchain transfers infrastructure.

The open protocol provides reusable transfer destinations and onchain execution. It is built on Base and supports direct, non-custodial USDC transfers.

got.cx product 🐐

Onchain transfer solutions.

Accept onchain transfers now.

got.cx turns the protocol into practical product experiences for creating, sharing, receiving, and managing transfers. Create a transfer link, share it or show its QR code, and let GOT handle the onchain details underneath.

Human context first. Onchain details on demand.

What developers can build

  • Transfer links and QR transfer experiences
  • Deterministic Intent Addresses with business references and committed metadata
  • Transfer flows for apps, fintech products, games, and services
  • Reusable human-readable transfer destinations
  • User deposit destinations
  • Recurring transfers using protocol subscriptions
  • Automated and agent-initiated transfers through the API and SDK
  • Processed transfer history, reporting, and reconciliation workflows

The product and protocol can be used together or independently. Integrators can use got.cx for its hosted API and product workflows, or integrate directly with the open protocol.

Create destination
      ↓
Share link / QR / identifier
      ↓
Transfer USDC
      ↓
Funds resolve onchain

GOT keeps the default experience focused on recipients, amounts, and references. Technical details such as the Base network, intent addresses, contract execution, and transaction hashes remain available when they are needed.

Build with GOT

Choose your integration layer

Resource Use it for
got.cx SDK Local Intent creation, typed managed API access, GOT links, and live protocol reads
GOT protocol SDK Direct protocol reads, writes, deployment metadata, ABIs, and name-key utilities
GOT protocol CLI Inspect deployments and ABIs, derive name keys, read contracts, and prepare unsigned calldata
API client guide Server or browser integration with the got.cx API
Protocol contracts Solidity source for the factory, intents, names, and subscriptions
Protocol specification Normative architecture, terminology, security model, and integration behavior
Product developer environment Run the got.cx web app, API, and workspace packages locally

Product SDK quick start

Install the typed got.cx SDK:

npm install @got-cx/sdk
import { createIntent } from "@got-cx/sdk";

const intent = createIntent({
  owner: "0x...",
  ref: "invoice:1042",
});

console.log(intent.address);

Machine API amounts use token base units. See the SDK documentation for the complete request type, Base chain and USDC constants, authentication, link parsing, errors, and client surface.

Protocol SDK quick start

Install the protocol package with its peer dependencies:

npm install @got-cx/protocol @wagmi/core viem
import { createConfig, http } from "@wagmi/core";
import { base } from "@wagmi/core/chains";
import {
  GOTFactoryAddressByChainId,
  readGOTFactoryProtocolVersion,
} from "@got-cx/protocol";

const config = createConfig({
  chains: [base],
  transports: { [base.id]: http() },
});

const factory = GOTFactoryAddressByChainId[base.id];
const protocolVersion = await readGOTFactoryProtocolVersion(config, {});

console.log(factory, protocolVersion);

For synchronous local derivation, import deriveIntentAddress(config) from the protocol package. It is byte-for-byte equivalent to GOTFactory.previewAddress. Continue with the protocol guide for deterministic intent creation, fee quotes, named routes, recurring transfers, deployment metadata, and safety requirements.

Integration examples

Repository layout

GOT/
β”œβ”€β”€ cx/                 got.cx web product, API, and product SDK
β”‚   β”œβ”€β”€ apps/web        landing page, transfer flows, and dashboard
β”‚   β”œβ”€β”€ apps/api        hosted product API
β”‚   └── packages/sdk    typed product and integration SDK
β”œβ”€β”€ protocol/           contracts, protocol SDK, CLI, tests, and deployments
β”œβ”€β”€ infra/              public TransferProcessed indexer and resolver workers
β”œβ”€β”€ .github/workflows   CI and scheduled public infrastructure
└── docs/SPEC.md        authoritative GOT protocol specification

Development

Node.js 22 or newer is required.

Run the got.cx workspace:

cd cx
npm install
npm run dev
npm run typecheck
npm run lint

Build and test the protocol:

cd protocol
npm install
npm run build
npm test

Read the product-specific environment and route documentation and the protocol contribution and safety notes before changing production flows.


Send it. GOT it.

About

Global Onchain Transfers for Everyone 🌐

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages