Fabric Protocol SDKs

SDK monorepo for Fabric EVM protocols.

Peer Dependencies

• viem
• wagmi-core

Version Compatability

| wagmi version | sdk version | | --- | --- | | 1.x.x | 0.3.6 | | 2.x.y | 1.0.0+ |

If you don't use wagmi or wagmi-core, you can leverage the protocols directly; see our docs.

Installation

npm i viem @wagmi/core @withfabric/protocol-sdks

Wagmi V2 Configuration

Wagmi v2 changed how configuration is managed. As a result the SDK needs to be configured with the wagmi configuration.

import { createConfig } from '@wagmi/core';
import { configureFabricSDK } from '@withfabric/protocol-sdks';

// Create wagmi configuration
const config = return createConfig({
  // ...
});

// Configure the SDK to use your wagmi configuration
configureFabricSDK({ wagmiConfig: config });

Protocols

CFPv1 - Crowd Financing Protocol

The Fabric CrowdFi protocol moves capital between creators and communities.

• Documentation
• Code

STP - Subscription Token Protocol

The Fabric Subscription Token Protocol provides onchain recurring revenue for creators and businesses.

V1

• Documentation
• Code

V2

• Documentation
• Code

Contributing / Running

In order to make changes, fork/clone the repo and run the setup script.

./script/setup

Tests can be run using

npm run test

We accept contributions via pull-request to the main branch. Please ensure your branch is rebased and squashed before issuing a PR.