Plan subskrypcji

Plan subskrypcji umożliwia sprzedawcy publikowanie warunków rozliczeniowych, które użytkownicy mogą zaakceptować. Po zasubskrybowaniu przez użytkownika, sprzedawca lub upoważniony pobierający może pobierać do kwoty określonej w planie w każdym okresie rozliczeniowym.

Ten przewodnik przedstawia pełny przepływ jako elementy składowe. Sprzedawca tworzy plan, subskrybent go akceptuje, a sprzedawca lub pobierający pobiera płatności z wynikowego PDA subskrypcji.

Instalacja

pnpm add @solana/subscriptions @solana/kit @solana/kit-plugin-rpc @solana/kit-plugin-signer @solana-program/token

Utworzenie planu

Sprzedawca jest właścicielem planu. PDA planu jest wyprowadzane z adresu sprzedawcy i planId.

import { address, createClient } from '@solana/kit';
import { solanaLocalRpc } from '@solana/kit-plugin-rpc';
import { signer } from '@solana/kit-plugin-signer';
import { findPlanPda, subscriptionsProgram } from '@solana/subscriptions';

const merchantClient = createClient()
  .use(signer(merchantSigner))
  .use(solanaLocalRpc({ rpcUrl: 'http://127.0.0.1:8899' }))
  .use(subscriptionsProgram());

const planId = 1n;
const tokenMint = address('TOKEN_MINT_ADDRESS_HERE');
const amount = 5_000_000n;
const periodHours = 720n;
const metadataUri = 'https://example.com/plan.json';
const destinations = [merchantSigner.address];
const pullers = [address('PULLER_WALLET_ADDRESS_HERE')];

await merchantClient.subscriptions.instructions
  .createPlan({
    planId,
    mint: tokenMint,
    amount,
    periodHours,
    endTs: 0n,
    destinations,
    pullers,
    metadataUri,
  })
  .sendTransaction();

const [planPda] = await findPlanPda({
  owner: merchantSigner.address,
  planId,
});

Aktualizacja planu

Sprzedawca może aktualizować modyfikowalne pola planu po jego utworzeniu. Dotychczasowi subskrybenci zachowują warunki, które zaakceptowali, podczas gdy nowi subskrybenci akceptują aktualne warunki planu.

import { PlanStatus } from '@solana/subscriptions';

const updatedMetadataUri = 'https://example.com/updated-plan.json';
const updatedPullers = [address('NEW_PULLER_WALLET_ADDRESS_HERE')];

await merchantClient.subscriptions.instructions
  .updatePlan({
    owner: merchantSigner,
    planPda,
    status: PlanStatus.Active,
    endTs: 0n,
    pullers: updatedPullers,
    metadataUri: updatedMetadataUri,
  })
  .sendTransaction();

Subskrybuj

Subskrybent akceptuje aktualne warunki planu. PDA subskrypcji jest wyprowadzane z PDA planu i adresu subskrybenta.

import { createClient } from '@solana/kit';
import { solanaLocalRpc } from '@solana/kit-plugin-rpc';
import { signer } from '@solana/kit-plugin-signer';
import { findAssociatedTokenPda, TOKEN_PROGRAM_ADDRESS } from '@solana-program/token';
import {
  fetchMaybeSubscriptionAuthority,
  findSubscriptionAuthorityPda,
  findSubscriptionDelegationPda,
  subscriptionsProgram,
} from '@solana/subscriptions';

const subscriberClient = createClient()
  .use(signer(subscriberSigner))
  .use(solanaLocalRpc({ rpcUrl: 'http://127.0.0.1:8899' }))
  .use(subscriptionsProgram());

const [subscriberAta] = await findAssociatedTokenPda({
  mint: tokenMint,
  owner: subscriberSigner.address,
  tokenProgram: TOKEN_PROGRAM_ADDRESS,
});

const [subscriptionAuthorityPda] = await findSubscriptionAuthorityPda({
  user: subscriberSigner.address,
  tokenMint,
});

const subscriptionAuthority = await fetchMaybeSubscriptionAuthority(
  subscriberClient.rpc,
  subscriptionAuthorityPda,
);

if (!subscriptionAuthority.exists) {
  await subscriberClient.subscriptions.instructions
    .initSubscriptionAuthority({
      tokenMint,
      tokenProgram: TOKEN_PROGRAM_ADDRESS,
      userAta: subscriberAta,
    })
    .sendTransaction();
}

await subscriberClient.subscriptions.instructions
  .subscribe({
    merchant: merchantSigner.address,
    planId,
    tokenMint,
  })
  .sendTransaction();

const [subscriptionPda] = await findSubscriptionDelegationPda({
  planPda,
  subscriber: subscriberSigner.address,
});

Pobierz płatność

Sprzedawca lub osoba z białej listy podpisuje pobranie. Gdy plan używa listy dozwolonych miejsc docelowych, właściciel konta tokenów odbiorcy musi znajdować się na liście w destinations.

const receiverAta = address('MERCHANT_TOKEN_ACCOUNT_ADDRESS_HERE');

await merchantClient.subscriptions.instructions
  .transferSubscription({
    caller: merchantOrPullerSigner,
    delegator: subscriberSigner.address,
    tokenMint,
    subscriptionPda,
    planPda,
    amount: 200_000n,
    receiverAta,
    tokenProgram: TOKEN_PROGRAM_ADDRESS,
  })
  .sendTransaction();

Anuluj i odwołaj

Anulowanie oznacza subskrypcję jako kończącą się. Odwołanie zamyka PDA subskrypcji po upływie terminu anulowania. Subskrybent podpisuje obie transakcje.

await subscriberClient.subscriptions.instructions
  .cancelSubscription({
    subscriber: subscriberSigner,
    planPda,
    subscriptionPda,
  })
  .sendTransaction();

// Run this after the cancelled subscription's expiresAtTs has elapsed.
await subscriberClient.subscriptions.instructions
  .revokeSubscription({
    authority: subscriberSigner,
    planPda,
    subscriptionPda,
  })
  .sendTransaction();

Uwagi

amount jest w jednostkach bazowych. Dla tokena z 6 miejscami dziesiętnymi, 5_000_000 oznacza 5 tokenów.
TypeScript SDK pobiera aktualne warunki planu podczas subscribe, gdy je pomijasz.
Rust SubscribeBuilder wymaga oczekiwanych warunków planu. Najpierw pobierz i zdekoduj konto planu, a następnie przekaż te pola przez SubscribeData.
Tylko sprzedawca lub portfel wymieniony w pullers może pobierać płatności.
Subskrybent podpisuje transakcje konfiguracji, anulowania i odwołania. Sprzedawca lub zatwierdzony pobierający podpisuje transakcje pobierania płatności.

Spis treści