aftermath-ts-sdk 1.3.23-perps.28 → 1.3.23-perps.30

package/dist/packages/referrals/referrals.d.ts

@@ -0,0 +1,27 @@
+import { Caller } from "../../general/utils/caller";
+import { ApiReferralsCreateReferralLinkBody, ApiReferralsCreateReferralLinkResponse, ApiReferralsGetRefereesBody, ApiReferralsGetRefereesResponse, ApiReferralsGetRefCodeBody, ApiReferralsGetRefCodeResponse, ApiReferralsSetReferrerBody, ApiReferralsSetReferrerResponse, CallerConfig, ApiReferralsIsRefCodeTakenBody, ApiReferralsIsRefCodeTakenResponse, ApiReferralsGetLinkedRefCodeBody, ApiReferralsGetLinkedRefCodeResponse } from "../../types";
+export declare class Referrals extends Caller {
+    static readonly constants: {};
+    constructor(config?: CallerConfig);
+    getRefCode(inputs: ApiReferralsGetRefCodeBody): Promise<ApiReferralsGetRefCodeResponse>;
+    getLinkedRefCode(inputs: ApiReferralsGetLinkedRefCodeBody): Promise<ApiReferralsGetLinkedRefCodeResponse>;
+    getReferees(inputs: ApiReferralsGetRefereesBody): Promise<ApiReferralsGetRefereesResponse>;
+    isRefCodeTaken(inputs: ApiReferralsIsRefCodeTakenBody): Promise<ApiReferralsIsRefCodeTakenResponse>;
+    createReferralLink(inputs: ApiReferralsCreateReferralLinkBody): Promise<ApiReferralsCreateReferralLinkResponse>;
+    setReferrer(inputs: ApiReferralsSetReferrerBody): Promise<ApiReferralsSetReferrerResponse>;
+    createReferralLinkMessageToSign(inputs: {
+        refCode: string;
+    }): {
+        action: string;
+        ref_code: string;
+        date: number;
+    };
+    setReferrerMessageToSign(inputs: {
+        refCode: string;
+    }): {
+        action: string;
+        ref_code: string;
+        date: number;
+    };
+}
+//# sourceMappingURL=referrals.d.ts.map

package/dist/packages/referrals/referrals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"referrals.d.ts","sourceRoot":"","sources":["../../../src/packages/referrals/referrals.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EACN,kCAAkC,EAClC,sCAAsC,EACtC,2BAA2B,EAC3B,+BAA+B,EAC/B,0BAA0B,EAC1B,8BAA8B,EAC9B,2BAA2B,EAC3B,+BAA+B,EAC/B,YAAY,EACZ,8BAA8B,EAC9B,kCAAkC,EAClC,gCAAgC,EAChC,oCAAoC,EAGpC,MAAM,aAAa,CAAC;AAErB,qBAAa,SAAU,SAAQ,MAAM;IAKpC,gBAAuB,SAAS,KAAM;gBAM1B,MAAM,CAAC,EAAE,YAAY;IAQpB,UAAU,CACtB,MAAM,EAAE,0BAA0B,GAChC,OAAO,CAAC,8BAA8B,CAAC;IAY7B,gBAAgB,CAC5B,MAAM,EAAE,gCAAgC,GACtC,OAAO,CAAC,oCAAoC,CAAC;IAenC,WAAW,CACvB,MAAM,EAAE,2BAA2B,GACjC,OAAO,CAAC,+BAA+B,CAAC;IAI9B,cAAc,CAC1B,MAAM,EAAE,8BAA8B,GACpC,OAAO,CAAC,kCAAkC,CAAC;IAQjC,kBAAkB,CAC9B,MAAM,EAAE,kCAAkC,GACxC,OAAO,CAAC,sCAAsC,CAAC;IAIrC,WAAW,CACvB,MAAM,EAAE,2BAA2B,GACjC,OAAO,CAAC,+BAA+B,CAAC;IAsBpC,+BAA+B,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE;;;;;IAQ3D,wBAAwB,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE;;;;;CAO3D"}

package/dist/packages/referrals/referrals.js

@@ -0,0 +1,95 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Referrals = void 0;
+const caller_1 = require("../../general/utils/caller");
+class Referrals extends caller_1.Caller {
+    // =========================================================================
+    //  Constructor
+    // =========================================================================
+    constructor(config) {
+        super(config, "referrals");
+    }
+    // =========================================================================
+    //  Fetching
+    // =========================================================================
+    getRefCode(inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // TODO: handle this better
+            const res = yield this.fetchApi("ref-code", inputs);
+            return Object.assign(Object.assign({}, res), { refCode: res.refCode === null ? undefined : res.refCode });
+        });
+    }
+    getLinkedRefCode(inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // TODO: handle this better
+            const res = yield this.fetchApi("linked-ref-code", inputs);
+            return Object.assign(Object.assign({}, res), { linkedRefCode: res.linkedRefCode === null ? undefined : res.linkedRefCode, linkedAt: res.linkedAt === null ? undefined : res.linkedAt });
+        });
+    }
+    getReferees(inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchApi("query", inputs);
+        });
+    }
+    isRefCodeTaken(inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchApi("availability", inputs);
+        });
+    }
+    // =========================================================================
+    //  Actions
+    // =========================================================================
+    createReferralLink(inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchApi("create", inputs);
+        });
+    }
+    setReferrer(inputs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.fetchApi("link", inputs);
+        });
+    }
+    // =========================================================================
+    //  Messages to Sign
+    // =========================================================================
+    // public getRefCodeMessageToSign() {
+    // 	return {
+    // 		action: "GET_REF_CODE",
+    // 		date: Date.now(),
+    // 	};
+    // }
+    // public getLinkedRefCodeMessageToSign() {
+    // 	return {
+    // 		action: "GET_LINKED_REF_CODE",
+    // 		date: Date.now(),
+    // 	};
+    // }
+    createReferralLinkMessageToSign(inputs) {
+        return {
+            action: "CREATE_REFERRAL",
+            ref_code: inputs.refCode,
+            date: Math.round(Date.now() / 1000),
+        };
+    }
+    setReferrerMessageToSign(inputs) {
+        return {
+            action: "LINK_REFERRAL",
+            ref_code: inputs.refCode,
+            date: Math.round(Date.now() / 1000),
+        };
+    }
+}
+exports.Referrals = Referrals;
+// =========================================================================
+//  Constants
+// =========================================================================
+Referrals.constants = {};

package/dist/packages/referrals/referralsTypes.d.ts

@@ -0,0 +1,166 @@
+import { SuiAddress, Timestamp } from "../../types";
+export interface ReferralsRefereeInfo {
+    /**
+     *  The wallet address of the referee
+     */
+    walletAddress: SuiAddress;
+    /**
+     *  When the referee joined via this ref link
+     */
+    joinedAt: Timestamp;
+}
+export interface ApiReferralsGetRefCodeBody {
+    /**
+     *  The wallet address to get referral code of
+     */
+    walletAddress: SuiAddress;
+    /**
+     * The bytes of the message signed by the user's wallet. Required for authentication.
+     */
+    bytes: string;
+    /**
+     * The signature of the message signed by the user's wallet. Required for authentication.
+     */
+    signature: string;
+}
+export interface ApiReferralsGetRefCodeResponse {
+    /**
+     *  The wallet address queried
+     */
+    address: SuiAddress;
+    /**
+     * The referral code of queried wallet address
+     */
+    refCode: string | undefined;
+}
+export interface ApiReferralsGetLinkedRefCodeBody {
+    /**
+     *  The wallet address to get linked referral code of
+     */
+    walletAddress: SuiAddress;
+    /**
+     * The bytes of the message signed by the user's wallet. Required for authentication.
+     */
+    bytes: string;
+    /**
+     * The signature of the message signed by the user's wallet. Required for authentication.
+     */
+    signature: string;
+}
+export interface ApiReferralsGetLinkedRefCodeResponse {
+    /**
+     *  The wallet address queried
+     */
+    address: SuiAddress;
+    /**
+     * The referral code linked to the queried wallet address
+     */
+    linkedRefCode: string | undefined;
+    /**
+     * Timestamp when the referral link was created (None if not linked)
+     */
+    linkedAt: Timestamp | undefined;
+}
+export interface ApiReferralsGetRefereesBody {
+    /**
+     * Ref code to get referees for
+     */
+    refCode: string;
+    limit?: number;
+    offset?: number;
+}
+export interface ApiReferralsGetRefereesResponse {
+    /**
+     * The referral code queried
+     */
+    refCode: string;
+    /**
+     * List of referees
+     */
+    referees: ReferralsRefereeInfo[];
+    /**
+     * Total number of referees (before pagination)
+     */
+    totalCount: number;
+}
+export interface ApiReferralsIsRefCodeTakenBody {
+    /**
+     * The referral code queried if taken
+     */
+    refCode: string;
+}
+export interface ApiReferralsIsRefCodeTakenResponse {
+    /**
+     * The referral code that was checked
+     */
+    refCode: string;
+    /**
+     * Whether this ref code is available for use (true = available, false = taken)
+     */
+    isAvailable: boolean;
+}
+export interface ApiReferralsCreateReferralLinkBody {
+    /**
+     * The wallet address of the user creating the ref link. Required for authentication.
+     */
+    walletAddress: SuiAddress;
+    /**
+     * The bytes of the message signed by the user's wallet. Required for authentication.
+     */
+    bytes: string;
+    /**
+     * The signature of the message signed by the user's wallet. Required for authentication.
+     */
+    signature: string;
+}
+export interface ApiReferralsCreateReferralLinkResponse {
+    /**
+     * The unique referral code/ID
+     */
+    refCode: string;
+    /**
+     * The wallet address of the referrer
+     */
+    walletAddress: SuiAddress;
+    /**
+     * Timestamp when the ref link was created
+     */
+    createdAt: Timestamp;
+    /**
+     * Status of the creation
+     */
+    status: string;
+}
+export interface ApiReferralsSetReferrerBody {
+    /**
+     * The wallet address of the referee. Required for authentication.
+     */
+    walletAddress: SuiAddress;
+    /**
+     * The bytes of the message signed by the referee's wallet. Required for authentication.
+     */
+    bytes: string;
+    /**
+     * The signature of the message signed by the referee's wallet. Required for authentication.
+     */
+    signature: string;
+}
+export interface ApiReferralsSetReferrerResponse {
+    /**
+     * The wallet address of the referee
+     */
+    refereeAddress: SuiAddress;
+    /**
+     * The referral code used
+     */
+    refCode: string;
+    /**
+     * Timestamp when the referral relationship was established
+     */
+    createdAt: Timestamp;
+    /**
+     * Status of the operation
+     */
+    status: string;
+}
+//# sourceMappingURL=referralsTypes.d.ts.map

package/dist/packages/referrals/referralsTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"referralsTypes.d.ts","sourceRoot":"","sources":["../../../src/packages/referrals/referralsTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAMpD,MAAM,WAAW,oBAAoB;IACpC;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;CACpB;AAMD,MAAM,WAAW,0BAA0B;IAC1C;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,8BAA8B;IAC9C;;OAEG;IACH,OAAO,EAAE,UAAU,CAAC;IACpB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B;AAED,MAAM,WAAW,gCAAgC;IAChD;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,oCAAoC;IACpD;;OAEG;IACH,OAAO,EAAE,UAAU,CAAC;IACpB;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC;;OAEG;IACH,QAAQ,EAAE,SAAS,GAAG,SAAS,CAAC;CAChC;AAED,MAAM,WAAW,2BAA2B;IAC3C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,+BAA+B;IAC/C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,EAAE,oBAAoB,EAAE,CAAC;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,8BAA8B;IAC9C;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,kCAAkC;IAClD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,WAAW,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,kCAAkC;IAClD;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,sCAAsC;IACtD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,2BAA2B;IAC3C;;OAEG;IACH,aAAa,EAAE,UAAU,CAAC;IAC1B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,+BAA+B;IAC/C;;OAEG;IACH,cAAc,EAAE,UAAU,CAAC;IAC3B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CACf"}

package/dist/packages/referrals/referralsTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types.d.ts

@@ -9,5 +9,6 @@ export * from "./packages/nftAmm/nftAmmTypes";
 export * from "./packages/auth/authTypes";
 export * from "./packages/farms/farmsTypes";
 export * from "./packages/perpetuals/perpetualsTypes";
+export * from "./packages/referrals/referralsTypes";
 export * from "./general/types";
 //# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,mDAAmD,CAAC;AAClE,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uCAAuC,CAAC;AAGtD,cAAc,iBAAiB,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iCAAiC,CAAC;AAChD,cAAc,mDAAmD,CAAC;AAClE,cAAc,2BAA2B,CAAC;AAC1C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uCAAuC,CAAC;AACtD,cAAc,qCAAqC,CAAC;AAGpD,cAAc,iBAAiB,CAAC"}

package/dist/types.js

@@ -25,5 +25,6 @@ __exportStar(require("./packages/nftAmm/nftAmmTypes"), exports);
 __exportStar(require("./packages/auth/authTypes"), exports);
 __exportStar(require("./packages/farms/farmsTypes"), exports);
 __exportStar(require("./packages/perpetuals/perpetualsTypes"), exports);
+__exportStar(require("./packages/referrals/referralsTypes"), exports);
 // TODO: make it so that casting types are not exported ?
 __exportStar(require("./general/types"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "aftermath-ts-sdk",
-	"version": "1.3.23-perps.28",
+	"version": "1.3.23-perps.30",
 	"description": "Aftermath TypeScript SDK",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",