@zing-protocol/zing-sdk 0.0.1

package/src/_generated/zing_studio/referral.ts

@@ -0,0 +1,447 @@
+/**************************************************************
+ * THIS FILE IS GENERATED AND SHOULD NOT BE MANUALLY MODIFIED *
+ **************************************************************/
+import { MoveStruct, normalizeMoveArguments } from "../utils/index.js";
+import { bcs } from "@mysten/sui/bcs";
+import type { RawTransactionArgument } from "../utils/index.js";
+import type { Transaction } from "@mysten/sui/transactions";
+
+const $moduleName = "@local-pkg/zing_studio::referral";
+export const ReferralCreatedEvent = new MoveStruct({
+  name: `${$moduleName}::ReferralCreatedEvent`,
+  fields: {
+    referrer: bcs.Address,
+    referee: bcs.Address,
+    timestamp_ms: bcs.u64(),
+  },
+});
+export const ReferralConfig = new MoveStruct({
+  name: `${$moduleName}::ReferralConfig`,
+  fields: {
+    share_percentage_bps: bcs.u64(),
+    program_duration: bcs.u64(),
+    max_cap: bcs.u64(),
+  },
+});
+export const Referral = new MoveStruct({
+  name: `${$moduleName}::Referral`,
+  fields: {
+    /** total earning count the value without deducted fee */
+    total_earning: bcs.u64(),
+    referrer: bcs.Address,
+    expired_at: bcs.u64(),
+  },
+});
+export interface AddReferralToConfigArguments {
+  config: RawTransactionArgument<string>;
+  Cap: RawTransactionArgument<string>;
+}
+export interface AddReferralToConfigOptions {
+  package?: string;
+  arguments:
+    | AddReferralToConfigArguments
+    | [
+        config: RawTransactionArgument<string>,
+        Cap: RawTransactionArgument<string>,
+      ];
+}
+export function addReferralToConfig(options: AddReferralToConfigOptions) {
+  const packageAddress = options.package ?? "@local-pkg/zing_studio";
+  const argumentsTypes = [
+    `${packageAddress}::config::Config`,
+    `${packageAddress}::admin::AdminCap`,
+  ] satisfies string[];
+  const parameterNames = ["config", "Cap"];
+  return (tx: Transaction) =>
+    tx.moveCall({
+      package: packageAddress,
+      module: "referral",
+      function: "add_referral_to_config",
+      arguments: normalizeMoveArguments(
+        options.arguments,
+        argumentsTypes,
+        parameterNames,
+      ),
+    });
+}
+export interface SharePercentageBpsArguments {
+  config: RawTransactionArgument<string>;
+}
+export interface SharePercentageBpsOptions {
+  package?: string;
+  arguments:
+    | SharePercentageBpsArguments
+    | [config: RawTransactionArgument<string>];
+}
+export function sharePercentageBps(options: SharePercentageBpsOptions) {
+  const packageAddress = options.package ?? "@local-pkg/zing_studio";
+  const argumentsTypes = [
+    `${packageAddress}::config::Config`,
+  ] satisfies string[];
+  const parameterNames = ["config"];
+  return (tx: Transaction) =>
+    tx.moveCall({
+      package: packageAddress,
+      module: "referral",
+      function: "share_percentage_bps",
+      arguments: normalizeMoveArguments(
+        options.arguments,
+        argumentsTypes,
+        parameterNames,
+      ),
+    });
+}
+export interface ProgramDurationArguments {
+  config: RawTransactionArgument<string>;
+}
+export interface ProgramDurationOptions {
+  package?: string;
+  arguments:
+    | ProgramDurationArguments
+    | [config: RawTransactionArgument<string>];
+}
+export function programDuration(options: ProgramDurationOptions) {
+  const packageAddress = options.package ?? "@local-pkg/zing_studio";
+  const argumentsTypes = [
+    `${packageAddress}::config::Config`,
+  ] satisfies string[];
+  const parameterNames = ["config"];
+  return (tx: Transaction) =>
+    tx.moveCall({
+      package: packageAddress,
+      module: "referral",
+      function: "program_duration",
+      arguments: normalizeMoveArguments(
+        options.arguments,
+        argumentsTypes,
+        parameterNames,
+      ),
+    });
+}
+export interface MaxCapArguments {
+  config: RawTransactionArgument<string>;
+}
+export interface MaxCapOptions {
+  package?: string;
+  arguments: MaxCapArguments | [config: RawTransactionArgument<string>];
+}
+export function maxCap(options: MaxCapOptions) {
+  const packageAddress = options.package ?? "@local-pkg/zing_studio";
+  const argumentsTypes = [
+    `${packageAddress}::config::Config`,
+  ] satisfies string[];
+  const parameterNames = ["config"];
+  return (tx: Transaction) =>
+    tx.moveCall({
+      package: packageAddress,
+      module: "referral",
+      function: "max_cap",
+      arguments: normalizeMoveArguments(
+        options.arguments,
+        argumentsTypes,
+        parameterNames,
+      ),
+    });
+}
+export interface UpdateSharePercentageBpsArguments {
+  config: RawTransactionArgument<string>;
+  Cap: RawTransactionArgument<string>;
+  sharePercentageBps: RawTransactionArgument<number | bigint>;
+}
+export interface UpdateSharePercentageBpsOptions {
+  package?: string;
+  arguments:
+    | UpdateSharePercentageBpsArguments
+    | [
+        config: RawTransactionArgument<string>,
+        Cap: RawTransactionArgument<string>,
+        sharePercentageBps: RawTransactionArgument<number | bigint>,
+      ];
+}
+export function updateSharePercentageBps(
+  options: UpdateSharePercentageBpsOptions,
+) {
+  const packageAddress = options.package ?? "@local-pkg/zing_studio";
+  const argumentsTypes = [
+    `${packageAddress}::config::Config`,
+    `${packageAddress}::admin::AdminCap`,
+    "u64",
+  ] satisfies string[];
+  const parameterNames = ["config", "Cap", "sharePercentageBps"];
+  return (tx: Transaction) =>
+    tx.moveCall({
+      package: packageAddress,
+      module: "referral",
+      function: "update_share_percentage_bps",
+      arguments: normalizeMoveArguments(
+        options.arguments,
+        argumentsTypes,
+        parameterNames,
+      ),
+    });
+}
+export interface UpdateProgramDurationArguments {
+  config: RawTransactionArgument<string>;
+  Cap: RawTransactionArgument<string>;
+  programDuration: RawTransactionArgument<number | bigint>;
+}
+export interface UpdateProgramDurationOptions {
+  package?: string;
+  arguments:
+    | UpdateProgramDurationArguments
+    | [
+        config: RawTransactionArgument<string>,
+        Cap: RawTransactionArgument<string>,
+        programDuration: RawTransactionArgument<number | bigint>,
+      ];
+}
+export function updateProgramDuration(options: UpdateProgramDurationOptions) {
+  const packageAddress = options.package ?? "@local-pkg/zing_studio";
+  const argumentsTypes = [
+    `${packageAddress}::config::Config`,
+    `${packageAddress}::admin::AdminCap`,
+    "u64",
+  ] satisfies string[];
+  const parameterNames = ["config", "Cap", "programDuration"];
+  return (tx: Transaction) =>
+    tx.moveCall({
+      package: packageAddress,
+      module: "referral",
+      function: "update_program_duration",
+      arguments: normalizeMoveArguments(
+        options.arguments,
+        argumentsTypes,
+        parameterNames,
+      ),
+    });
+}
+export interface UpdateMaxCapArguments {
+  config: RawTransactionArgument<string>;
+  Cap: RawTransactionArgument<string>;
+  maxCap: RawTransactionArgument<number | bigint>;
+}
+export interface UpdateMaxCapOptions {
+  package?: string;
+  arguments:
+    | UpdateMaxCapArguments
+    | [
+        config: RawTransactionArgument<string>,
+        Cap: RawTransactionArgument<string>,
+        maxCap: RawTransactionArgument<number | bigint>,
+      ];
+}
+export function updateMaxCap(options: UpdateMaxCapOptions) {
+  const packageAddress = options.package ?? "@local-pkg/zing_studio";
+  const argumentsTypes = [
+    `${packageAddress}::config::Config`,
+    `${packageAddress}::admin::AdminCap`,
+    "u64",
+  ] satisfies string[];
+  const parameterNames = ["config", "Cap", "maxCap"];
+  return (tx: Transaction) =>
+    tx.moveCall({
+      package: packageAddress,
+      module: "referral",
+      function: "update_max_cap",
+      arguments: normalizeMoveArguments(
+        options.arguments,
+        argumentsTypes,
+        parameterNames,
+      ),
+    });
+}
+export interface ReferralArguments {
+  studio: RawTransactionArgument<string>;
+}
+export interface ReferralOptions {
+  package?: string;
+  arguments: ReferralArguments | [studio: RawTransactionArgument<string>];
+}
+export function referral(options: ReferralOptions) {
+  const packageAddress = options.package ?? "@local-pkg/zing_studio";
+  const argumentsTypes = [
+    `${packageAddress}::studio::Studio`,
+  ] satisfies string[];
+  const parameterNames = ["studio"];
+  return (tx: Transaction) =>
+    tx.moveCall({
+      package: packageAddress,
+      module: "referral",
+      function: "referral",
+      arguments: normalizeMoveArguments(
+        options.arguments,
+        argumentsTypes,
+        parameterNames,
+      ),
+    });
+}
+export interface IsReferralExistsArguments {
+  studio: RawTransactionArgument<string>;
+}
+export interface IsReferralExistsOptions {
+  package?: string;
+  arguments:
+    | IsReferralExistsArguments
+    | [studio: RawTransactionArgument<string>];
+}
+export function isReferralExists(options: IsReferralExistsOptions) {
+  const packageAddress = options.package ?? "@local-pkg/zing_studio";
+  const argumentsTypes = [
+    `${packageAddress}::studio::Studio`,
+  ] satisfies string[];
+  const parameterNames = ["studio"];
+  return (tx: Transaction) =>
+    tx.moveCall({
+      package: packageAddress,
+      module: "referral",
+      function: "is_referral_exists",
+      arguments: normalizeMoveArguments(
+        options.arguments,
+        argumentsTypes,
+        parameterNames,
+      ),
+    });
+}
+export interface TotalEarningArguments {
+  self: RawTransactionArgument<string>;
+}
+export interface TotalEarningOptions {
+  package?: string;
+  arguments: TotalEarningArguments | [self: RawTransactionArgument<string>];
+}
+export function totalEarning(options: TotalEarningOptions) {
+  const packageAddress = options.package ?? "@local-pkg/zing_studio";
+  const argumentsTypes = [
+    `${packageAddress}::referral::Referral`,
+  ] satisfies string[];
+  const parameterNames = ["self"];
+  return (tx: Transaction) =>
+    tx.moveCall({
+      package: packageAddress,
+      module: "referral",
+      function: "total_earning",
+      arguments: normalizeMoveArguments(
+        options.arguments,
+        argumentsTypes,
+        parameterNames,
+      ),
+    });
+}
+export interface ReferrerArguments {
+  self: RawTransactionArgument<string>;
+}
+export interface ReferrerOptions {
+  package?: string;
+  arguments: ReferrerArguments | [self: RawTransactionArgument<string>];
+}
+export function referrer(options: ReferrerOptions) {
+  const packageAddress = options.package ?? "@local-pkg/zing_studio";
+  const argumentsTypes = [
+    `${packageAddress}::referral::Referral`,
+  ] satisfies string[];
+  const parameterNames = ["self"];
+  return (tx: Transaction) =>
+    tx.moveCall({
+      package: packageAddress,
+      module: "referral",
+      function: "referrer",
+      arguments: normalizeMoveArguments(
+        options.arguments,
+        argumentsTypes,
+        parameterNames,
+      ),
+    });
+}
+export interface ExpiredAtArguments {
+  self: RawTransactionArgument<string>;
+}
+export interface ExpiredAtOptions {
+  package?: string;
+  arguments: ExpiredAtArguments | [self: RawTransactionArgument<string>];
+}
+export function expiredAt(options: ExpiredAtOptions) {
+  const packageAddress = options.package ?? "@local-pkg/zing_studio";
+  const argumentsTypes = [
+    `${packageAddress}::referral::Referral`,
+  ] satisfies string[];
+  const parameterNames = ["self"];
+  return (tx: Transaction) =>
+    tx.moveCall({
+      package: packageAddress,
+      module: "referral",
+      function: "expired_at",
+      arguments: normalizeMoveArguments(
+        options.arguments,
+        argumentsTypes,
+        parameterNames,
+      ),
+    });
+}
+export interface AddTotalEarningArguments {
+  self: RawTransactionArgument<string>;
+  value: RawTransactionArgument<number | bigint>;
+}
+export interface AddTotalEarningOptions {
+  package?: string;
+  arguments:
+    | AddTotalEarningArguments
+    | [
+        self: RawTransactionArgument<string>,
+        value: RawTransactionArgument<number | bigint>,
+      ];
+}
+export function addTotalEarning(options: AddTotalEarningOptions) {
+  const packageAddress = options.package ?? "@local-pkg/zing_studio";
+  const argumentsTypes = [
+    `${packageAddress}::referral::Referral`,
+    "u64",
+  ] satisfies string[];
+  const parameterNames = ["self", "value"];
+  return (tx: Transaction) =>
+    tx.moveCall({
+      package: packageAddress,
+      module: "referral",
+      function: "add_total_earning",
+      arguments: normalizeMoveArguments(
+        options.arguments,
+        argumentsTypes,
+        parameterNames,
+      ),
+    });
+}
+export interface AddReferralToStudioArguments {
+  studio: RawTransactionArgument<string>;
+  config: RawTransactionArgument<string>;
+  referrer: RawTransactionArgument<string>;
+}
+export interface AddReferralToStudioOptions {
+  package?: string;
+  arguments:
+    | AddReferralToStudioArguments
+    | [
+        studio: RawTransactionArgument<string>,
+        config: RawTransactionArgument<string>,
+        referrer: RawTransactionArgument<string>,
+      ];
+}
+export function addReferralToStudio(options: AddReferralToStudioOptions) {
+  const packageAddress = options.package ?? "@local-pkg/zing_studio";
+  const argumentsTypes = [
+    `${packageAddress}::studio::Studio`,
+    `${packageAddress}::config::Config`,
+    "address",
+    "0x0000000000000000000000000000000000000000000000000000000000000002::clock::Clock",
+  ] satisfies string[];
+  const parameterNames = ["studio", "config", "referrer"];
+  return (tx: Transaction) =>
+    tx.moveCall({
+      package: packageAddress,
+      module: "referral",
+      function: "add_referral_to_studio",
+      arguments: normalizeMoveArguments(
+        options.arguments,
+        argumentsTypes,
+        parameterNames,
+      ),
+    });
+}