@tributary-so/sdk
    Preparing search index...

    Class Tributary

    Index

    Constructors

    constructor

    Properties

    connection program programId provider

    Methods

    changeGatewayFeeRecipient changeGatewaySigner changePaymentPolicyStatus createPaymentGateway createPaymentPolicy createSubscriptionInstruction createUserPayment deletePaymentGateway deletePaymentPolicy executePayment getAllPaymentGateway getAllPaymentPolicies getAllUserPayments getAllUserPaymentsByOwner getConfigPda getGatewayPda getPaymentGateway getPaymentPoliciesByGateway getPaymentPoliciesByRecipient getPaymentPoliciesByUser getPaymentPolicy getPaymentPolicyPda getPaymentsDelegatePda getProgramConfig getUserPayment getUserPaymentPda initialize updateWallet

    Constructors

    Properties

    connection: Connection
    program: Program<RecurringPayments>
    programId: PublicKey
    provider: AnchorProvider

    Methods

    • Parameters

      • gatewayAuthority: PublicKey
      • newFeeRecipient: PublicKey

      Returns Promise<TransactionInstruction>

    • Parameters

      • gatewayAuthority: PublicKey
      • newSigner: PublicKey

      Returns Promise<TransactionInstruction>

    • Parameters

      • tokenMint: PublicKey
      • policyId: number
      • newStatus: { active: {} } | { paused: {} }

      Returns Promise<TransactionInstruction>

    • Parameters

      • authority: PublicKey
      • gatewayFeeBps: number
      • gatewayFeeRecipient: PublicKey
      • name: string
      • url: string

      Returns Promise<TransactionInstruction>

    • Parameters

      • tokenMint: PublicKey
      • recipient: PublicKey
      • gateway: PublicKey
      • amount: BN
      • autoRenew: boolean
      • maxRenewals: number | null
      • paymentFrequency: DecodeEnum
      • memo: number[]
      • OptionalstartTime: BN | null

      Returns Promise<TransactionInstruction>

    • Parameters

      • tokenMint: PublicKey
      • recipient: PublicKey
      • gateway: PublicKey
      • amount: BN
      • autoRenew: boolean
      • maxRenewals: number | null
      • paymentFrequency: DecodeEnum
      • memo: number[]
      • OptionalstartTime: BN | null
      • OptionalapprovalAmount: BN
      • OptionalexecuteImmediately: boolean

      Returns Promise<TransactionInstruction[]>

    • Parameters

      • tokenMint: PublicKey

      Returns Promise<TransactionInstruction>

    • Parameters

      • gatewayAuthority: PublicKey

      Returns Promise<TransactionInstruction>

    • Parameters

      • tokenMint: PublicKey
      • policyId: number

      Returns Promise<TransactionInstruction>

    • Parameters

      • paymentPolicyPda: PublicKey
      • Optionalrecipient: PublicKey
      • OptionaltokenMint: PublicKey
      • Optionalgateway: PublicKey
      • Optionaluser: PublicKey

      Returns Promise<TransactionInstruction[]>

    • Returns Promise<
          {
              account: {
                  authority: PublicKey;
                  bump: number;
                  createdAt: BN;
                  feeRecipient: PublicKey;
                  gatewayFeeBps: number;
                  isActive: boolean;
                  name: number[];
                  padding: number[];
                  signer: PublicKey;
                  totalProcessed: BN;
                  url: number[];
              };
              publicKey: PublicKey;
          }[],
      >

    • Returns Promise<
          {
              account: {
                  bump: number;
                  createdAt: BN;
                  gateway: PublicKey;
                  memo: number[];
                  padding: number[];
                  paymentCount: number;
                  policyId: number;
                  policyType: {} & {
                      subscription: {
                          amount: BN;
                          autoRenew: boolean;
                          maxRenewals: number
                          | null;
                          nextPaymentDue: BN;
                          padding: number[];
                          paymentFrequency: DecodeEnum<
                              {
                                  kind: "enum";
                                  variants: [
                                      { name: ... },
                                      { name: ... },
                                      { name: ... },
                                      { name: ... },
                                      { name: ... },
                                      { name: ... },
                                      { fields: ...; name: ... },
                                  ];
                              },
                              DecodedHelper<
                                  [
                                      { docs: ...; name: ...; type: ... },
                                      { docs: ...; name: ...; type: ... },
                                      { docs: ...; name: ...; type: ... },
                                  ],
                                  EmptyDefined,
                              >,
                          >;
                      };
                  };
                  recipient: PublicKey;
                  status: DecodeEnum<
                      { kind: "enum"; variants: [{ name: "active" }, { name: "paused" }] },
                      DecodedHelper<
                          [
                              {
                                  docs: [
                                      "An event that is thrown when a gateway fee recipient is changed",
                                  ];
                                  name: "gatewayFeeRecipientChanged";
                                  type: {
                                      fields: [
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                      ];
                                      kind: "struct";
                                  };
                              },
                              {
                                  docs: ["An event that is thrown when a gateway signer is changed"];
                                  name: "gatewaySignerChanged";
                                  type: {
                                      fields: [
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                      ];
                                      kind: "struct";
                                  };
                              },
                              {
                                  docs: [
                                      "Simplify the payment frequency while also allowing a custom period as well,",
                                      "defined in seconds.",
                                  ];
                                  name: "paymentFrequency";
                                  type: {
                                      kind: "enum";
                                      variants: [
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { fields: ...; name: ... },
                                      ];
                                  };
                              },
                          ],
                          DecodedHelper<
                              [
                                  {
                                      docs: [
                                          "An event that is thrown when a gateway fee recipient is changed",
                                      ];
                                      name: "gatewayFeeRecipientChanged";
                                      type: { fields: [(...), (...), (...)]; kind: "struct" };
                                  },
                                  {
                                      docs: [
                                          "An event that is thrown when a gateway signer is changed",
                                      ];
                                      name: "gatewaySignerChanged";
                                      type: { fields: [(...), (...), (...)]; kind: "struct" };
                                  },
                                  {
                                      docs: [
                                          "Simplify the payment frequency while also allowing a custom period as well,",
                                          "defined in seconds.",
                                      ];
                                      name: "paymentFrequency";
                                      type: {
                                          kind: "enum";
                                          variants: [(...), (...), (...), (...), (...), (...), (...)];
                                      };
                                  },
                              ],
                              EmptyDefined,
                          >,
                      >,
                  >;
                  totalPaid: BN;
                  updatedAt: BN;
                  userPayment: PublicKey;
              };
              publicKey: PublicKey;
          }[],
      >

    • Returns Promise<
          {
              account: {
                  activePoliciesCount: number;
                  bump: number;
                  createdAt: BN;
                  isActive: boolean;
                  owner: PublicKey;
                  padding: number[];
                  tokenAccount: PublicKey;
                  tokenMint: PublicKey;
                  updatedAt: BN;
              };
              publicKey: PublicKey;
          }[],
      >

    • Parameters

      • owner: PublicKey

      Returns Promise<
          {
              account: {
                  activePoliciesCount: number;
                  bump: number;
                  createdAt: BN;
                  isActive: boolean;
                  owner: PublicKey;
                  padding: number[];
                  tokenAccount: PublicKey;
                  tokenMint: PublicKey;
                  updatedAt: BN;
              };
              publicKey: PublicKey;
          }[],
      >

    • Parameters

      • gatewayAddress: PublicKey

      Returns Promise<
          | {
              authority: PublicKey;
              bump: number;
              createdAt: BN;
              feeRecipient: PublicKey;
              gatewayFeeBps: number;
              isActive: boolean;
              name: number[];
              padding: number[];
              signer: PublicKey;
              totalProcessed: BN;
              url: number[];
          }
          | null,
      >

    • Parameters

      • gateway: PublicKey

      Returns Promise<
          {
              account: {
                  bump: number;
                  createdAt: BN;
                  gateway: PublicKey;
                  memo: number[];
                  padding: number[];
                  paymentCount: number;
                  policyId: number;
                  policyType: {} & {
                      subscription: {
                          amount: BN;
                          autoRenew: boolean;
                          maxRenewals: number
                          | null;
                          nextPaymentDue: BN;
                          padding: number[];
                          paymentFrequency: DecodeEnum<
                              {
                                  kind: "enum";
                                  variants: [
                                      { name: ... },
                                      { name: ... },
                                      { name: ... },
                                      { name: ... },
                                      { name: ... },
                                      { name: ... },
                                      { fields: ...; name: ... },
                                  ];
                              },
                              DecodedHelper<
                                  [
                                      { docs: ...; name: ...; type: ... },
                                      { docs: ...; name: ...; type: ... },
                                      { docs: ...; name: ...; type: ... },
                                  ],
                                  EmptyDefined,
                              >,
                          >;
                      };
                  };
                  recipient: PublicKey;
                  status: DecodeEnum<
                      { kind: "enum"; variants: [{ name: "active" }, { name: "paused" }] },
                      DecodedHelper<
                          [
                              {
                                  docs: [
                                      "An event that is thrown when a gateway fee recipient is changed",
                                  ];
                                  name: "gatewayFeeRecipientChanged";
                                  type: {
                                      fields: [
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                      ];
                                      kind: "struct";
                                  };
                              },
                              {
                                  docs: ["An event that is thrown when a gateway signer is changed"];
                                  name: "gatewaySignerChanged";
                                  type: {
                                      fields: [
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                      ];
                                      kind: "struct";
                                  };
                              },
                              {
                                  docs: [
                                      "Simplify the payment frequency while also allowing a custom period as well,",
                                      "defined in seconds.",
                                  ];
                                  name: "paymentFrequency";
                                  type: {
                                      kind: "enum";
                                      variants: [
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { fields: ...; name: ... },
                                      ];
                                  };
                              },
                          ],
                          DecodedHelper<
                              [
                                  {
                                      docs: [
                                          "An event that is thrown when a gateway fee recipient is changed",
                                      ];
                                      name: "gatewayFeeRecipientChanged";
                                      type: { fields: [(...), (...), (...)]; kind: "struct" };
                                  },
                                  {
                                      docs: [
                                          "An event that is thrown when a gateway signer is changed",
                                      ];
                                      name: "gatewaySignerChanged";
                                      type: { fields: [(...), (...), (...)]; kind: "struct" };
                                  },
                                  {
                                      docs: [
                                          "Simplify the payment frequency while also allowing a custom period as well,",
                                          "defined in seconds.",
                                      ];
                                      name: "paymentFrequency";
                                      type: {
                                          kind: "enum";
                                          variants: [(...), (...), (...), (...), (...), (...), (...)];
                                      };
                                  },
                              ],
                              EmptyDefined,
                          >,
                      >,
                  >;
                  totalPaid: BN;
                  updatedAt: BN;
                  userPayment: PublicKey;
              };
              publicKey: PublicKey;
          }[],
      >

    • Parameters

      • user: PublicKey

      Returns Promise<
          {
              account: {
                  bump: number;
                  createdAt: BN;
                  gateway: PublicKey;
                  memo: number[];
                  padding: number[];
                  paymentCount: number;
                  policyId: number;
                  policyType: {} & {
                      subscription: {
                          amount: BN;
                          autoRenew: boolean;
                          maxRenewals: number
                          | null;
                          nextPaymentDue: BN;
                          padding: number[];
                          paymentFrequency: DecodeEnum<
                              {
                                  kind: "enum";
                                  variants: [
                                      { name: ... },
                                      { name: ... },
                                      { name: ... },
                                      { name: ... },
                                      { name: ... },
                                      { name: ... },
                                      { fields: ...; name: ... },
                                  ];
                              },
                              DecodedHelper<
                                  [
                                      { docs: ...; name: ...; type: ... },
                                      { docs: ...; name: ...; type: ... },
                                      { docs: ...; name: ...; type: ... },
                                  ],
                                  EmptyDefined,
                              >,
                          >;
                      };
                  };
                  recipient: PublicKey;
                  status: DecodeEnum<
                      { kind: "enum"; variants: [{ name: "active" }, { name: "paused" }] },
                      DecodedHelper<
                          [
                              {
                                  docs: [
                                      "An event that is thrown when a gateway fee recipient is changed",
                                  ];
                                  name: "gatewayFeeRecipientChanged";
                                  type: {
                                      fields: [
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                      ];
                                      kind: "struct";
                                  };
                              },
                              {
                                  docs: ["An event that is thrown when a gateway signer is changed"];
                                  name: "gatewaySignerChanged";
                                  type: {
                                      fields: [
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                      ];
                                      kind: "struct";
                                  };
                              },
                              {
                                  docs: [
                                      "Simplify the payment frequency while also allowing a custom period as well,",
                                      "defined in seconds.",
                                  ];
                                  name: "paymentFrequency";
                                  type: {
                                      kind: "enum";
                                      variants: [
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { fields: ...; name: ... },
                                      ];
                                  };
                              },
                          ],
                          DecodedHelper<
                              [
                                  {
                                      docs: [
                                          "An event that is thrown when a gateway fee recipient is changed",
                                      ];
                                      name: "gatewayFeeRecipientChanged";
                                      type: { fields: [(...), (...), (...)]; kind: "struct" };
                                  },
                                  {
                                      docs: [
                                          "An event that is thrown when a gateway signer is changed",
                                      ];
                                      name: "gatewaySignerChanged";
                                      type: { fields: [(...), (...), (...)]; kind: "struct" };
                                  },
                                  {
                                      docs: [
                                          "Simplify the payment frequency while also allowing a custom period as well,",
                                          "defined in seconds.",
                                      ];
                                      name: "paymentFrequency";
                                      type: {
                                          kind: "enum";
                                          variants: [(...), (...), (...), (...), (...), (...), (...)];
                                      };
                                  },
                              ],
                              EmptyDefined,
                          >,
                      >,
                  >;
                  totalPaid: BN;
                  updatedAt: BN;
                  userPayment: PublicKey;
              };
              publicKey: PublicKey;
          }[],
      >

    • Parameters

      • user: PublicKey

      Returns Promise<
          {
              account: {
                  bump: number;
                  createdAt: BN;
                  gateway: PublicKey;
                  memo: number[];
                  padding: number[];
                  paymentCount: number;
                  policyId: number;
                  policyType: {} & {
                      subscription: {
                          amount: BN;
                          autoRenew: boolean;
                          maxRenewals: number
                          | null;
                          nextPaymentDue: BN;
                          padding: number[];
                          paymentFrequency: DecodeEnum<
                              {
                                  kind: "enum";
                                  variants: [
                                      { name: ... },
                                      { name: ... },
                                      { name: ... },
                                      { name: ... },
                                      { name: ... },
                                      { name: ... },
                                      { fields: ...; name: ... },
                                  ];
                              },
                              DecodedHelper<
                                  [
                                      { docs: ...; name: ...; type: ... },
                                      { docs: ...; name: ...; type: ... },
                                      { docs: ...; name: ...; type: ... },
                                  ],
                                  EmptyDefined,
                              >,
                          >;
                      };
                  };
                  recipient: PublicKey;
                  status: DecodeEnum<
                      { kind: "enum"; variants: [{ name: "active" }, { name: "paused" }] },
                      DecodedHelper<
                          [
                              {
                                  docs: [
                                      "An event that is thrown when a gateway fee recipient is changed",
                                  ];
                                  name: "gatewayFeeRecipientChanged";
                                  type: {
                                      fields: [
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                      ];
                                      kind: "struct";
                                  };
                              },
                              {
                                  docs: ["An event that is thrown when a gateway signer is changed"];
                                  name: "gatewaySignerChanged";
                                  type: {
                                      fields: [
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                      ];
                                      kind: "struct";
                                  };
                              },
                              {
                                  docs: [
                                      "Simplify the payment frequency while also allowing a custom period as well,",
                                      "defined in seconds.",
                                  ];
                                  name: "paymentFrequency";
                                  type: {
                                      kind: "enum";
                                      variants: [
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { fields: ...; name: ... },
                                      ];
                                  };
                              },
                          ],
                          DecodedHelper<
                              [
                                  {
                                      docs: [
                                          "An event that is thrown when a gateway fee recipient is changed",
                                      ];
                                      name: "gatewayFeeRecipientChanged";
                                      type: { fields: [(...), (...), (...)]; kind: "struct" };
                                  },
                                  {
                                      docs: [
                                          "An event that is thrown when a gateway signer is changed",
                                      ];
                                      name: "gatewaySignerChanged";
                                      type: { fields: [(...), (...), (...)]; kind: "struct" };
                                  },
                                  {
                                      docs: [
                                          "Simplify the payment frequency while also allowing a custom period as well,",
                                          "defined in seconds.",
                                      ];
                                      name: "paymentFrequency";
                                      type: {
                                          kind: "enum";
                                          variants: [(...), (...), (...), (...), (...), (...), (...)];
                                      };
                                  },
                              ],
                              EmptyDefined,
                          >,
                      >,
                  >;
                  totalPaid: BN;
                  updatedAt: BN;
                  userPayment: PublicKey;
              };
              publicKey: PublicKey;
          }[],
      >

    • Parameters

      • policyAddress: PublicKey

      Returns Promise<
          | {
              bump: number;
              createdAt: BN;
              gateway: PublicKey;
              memo: number[];
              padding: number[];
              paymentCount: number;
              policyId: number;
              policyType: {} & {
                  subscription: {
                      amount: BN;
                      autoRenew: boolean;
                      maxRenewals: number
                      | null;
                      nextPaymentDue: BN;
                      padding: number[];
                      paymentFrequency: DecodeEnum<
                          {
                              kind: "enum";
                              variants: [
                                  { name: "daily" },
                                  { name: "weekly" },
                                  { name: "monthly" },
                                  { name: "quarterly" },
                                  { name: "semiAnnually" },
                                  { name: "annually" },
                                  { fields: [(...)]; name: "custom" },
                              ];
                          },
                          DecodedHelper<
                              [
                                  {
                                      docs: [(...)];
                                      name: "gatewayFeeRecipientChanged";
                                      type: { fields: ...; kind: ... };
                                  },
                                  {
                                      docs: [(...)];
                                      name: "gatewaySignerChanged";
                                      type: { fields: ...; kind: ... };
                                  },
                                  {
                                      docs: [(...), (...)];
                                      name: "paymentFrequency";
                                      type: { kind: ...; variants: ... };
                                  },
                              ],
                              EmptyDefined,
                          >,
                      >;
                  };
              };
              recipient: PublicKey;
              status: DecodeEnum<
                  { kind: "enum"; variants: [{ name: "active" }, { name: "paused" }] },
                  DecodedHelper<
                      [
                          {
                              docs: [
                                  "An event that is thrown when a gateway fee recipient is changed",
                              ];
                              name: "gatewayFeeRecipientChanged";
                              type: {
                                  fields: [
                                      { name: "gateway"; type: "pubkey" },
                                      { name: "oldFeeRecipient"; type: "pubkey" },
                                      { name: "newFeeRecipient"; type: "pubkey" },
                                  ];
                                  kind: "struct";
                              };
                          },
                          {
                              docs: ["An event that is thrown when a gateway signer is changed"];
                              name: "gatewaySignerChanged";
                              type: {
                                  fields: [
                                      { name: "gateway"; type: "pubkey" },
                                      { name: "oldSigner"; type: "pubkey" },
                                      { name: "newSigner"; type: "pubkey" },
                                  ];
                                  kind: "struct";
                              };
                          },
                          {
                              docs: [
                                  "Simplify the payment frequency while also allowing a custom period as well,",
                                  "defined in seconds.",
                              ];
                              name: "paymentFrequency";
                              type: {
                                  kind: "enum";
                                  variants: [
                                      { name: "daily" },
                                      { name: "weekly" },
                                      { name: "monthly" },
                                      { name: "quarterly" },
                                      { name: "semiAnnually" },
                                      { name: "annually" },
                                      { fields: [(...)]; name: "custom" },
                                  ];
                              };
                          },
                      ],
                      DecodedHelper<
                          [
                              {
                                  docs: [
                                      "An event that is thrown when a gateway fee recipient is changed",
                                  ];
                                  name: "gatewayFeeRecipientChanged";
                                  type: {
                                      fields: [
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                      ];
                                      kind: "struct";
                                  };
                              },
                              {
                                  docs: ["An event that is thrown when a gateway signer is changed"];
                                  name: "gatewaySignerChanged";
                                  type: {
                                      fields: [
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                          { name: ...; type: ... },
                                      ];
                                      kind: "struct";
                                  };
                              },
                              {
                                  docs: [
                                      "Simplify the payment frequency while also allowing a custom period as well,",
                                      "defined in seconds.",
                                  ];
                                  name: "paymentFrequency";
                                  type: {
                                      kind: "enum";
                                      variants: [
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { name: ... },
                                          { fields: ...; name: ... },
                                      ];
                                  };
                              },
                          ],
                          EmptyDefined,
                      >,
                  >,
              >;
              totalPaid: BN;
              updatedAt: BN;
              userPayment: PublicKey;
          }
          | null,
      >

    • Parameters

      • configAddress: PublicKey

      Returns Promise<
          | {
              admin: PublicKey;
              bump: number;
              emergencyPause: boolean;
              feeRecipient: PublicKey;
              maxPoliciesPerUser: number;
              padding: number[];
              protocolFeeBps: number;
          }
          | null,
      >

    • Parameters

      • userPaymentAddress: PublicKey

      Returns Promise<
          | {
              activePoliciesCount: number;
              bump: number;
              createdAt: BN;
              isActive: boolean;
              owner: PublicKey;
              padding: number[];
              tokenAccount: PublicKey;
              tokenMint: PublicKey;
              updatedAt: BN;
          }
          | null,
      >

    • Parameters

      • admin: PublicKey

      Returns Promise<TransactionInstruction>

    • Parameters

      • wallet: any

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods