Latest
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685import { TradeManager } from "./trade_manager.ts";import { SteamError, throwIfHasError } from "./steam_error.ts";import { CancelTradeOffer, DeclineTradeOffer, GetTradeOffer, GetTradeStatus, Offer, TradeDetailAsset,} from "./steam_api/requests/IEconService.ts";import { EconItem, FromOfferItemOptions, RequiredItemProps,} from "./econ_item.ts";import { SteamID } from "../deps.ts";import { EConfirmationMethod } from "./enums/EConfirmationMethod.ts";import { ETradeOfferState } from "./enums/ETradeOfferState.ts";import type { ServiceRequest } from "./steam_api/requests/service_request.ts";import { hasNoName } from "./utils.ts";import { ETradeStatus } from "./enums/ETradeStatus.ts";
const NON_TERMINAL_OFFER_STATES = [ ETradeOfferState.Active, ETradeOfferState.CreatedNeedsConfirmation, ETradeOfferState.InEscrow,];
export function isNonTerminalState( offerOrState: Offer | TradeOffer | ETradeOfferState,) { if (typeof offerOrState === "number") { return NON_TERMINAL_OFFER_STATES.includes(offerOrState); } else if ("trade_offer_state" in offerOrState) { return NON_TERMINAL_OFFER_STATES.includes(offerOrState.trade_offer_state); } else { return NON_TERMINAL_OFFER_STATES.includes(offerOrState.state); }}
const INTERNAL_USE_FLAG = "_internal_use_flag";
export class TradeOffer { manager: TradeManager; /** The other party in this offer, as a SteamID object */ partner?: SteamID; /** The trade offer's unique numeric ID, represented as a string */ id: string | undefined; /** A message, possibly empty, included with the trade offer by its sender */ message: string | undefined; /** A value from the ETradeOfferState enum */ state: ETradeOfferState; /** * An array of items to be given from your account should this offer be accepted * If this offer has not yet been sent or was just sent, object in this array will not contain classid or instanceid properties, as it would had you loaded a sent offer */ itemsToGive: Array<EconItem>; /** * An array of items to be given from the other account and received by yours should this offer be accepted * If this offer has not yet been sent or was just sent, object in this array will not contain classid or instanceid properties, as it would had you loaded a sent offer */ itemsToReceive: Array<EconItem>; /** `true` if this offer was sent by you, `false` if you received it */ isOurOffer: boolean | undefined; /** A Date object representing when the trade offer was sent */ created: Date | undefined; /** A Date object representing when the trade offer was last updated (equal to created if never updated) */ updated: Date | undefined; /** A Date object representing when the trade offer will expire if not acted on */ expires: Date | undefined; /** A numeric trade ID, represented as a string, if the offer was accepted. null otherwise. This value won't be very useful to you. */ tradeID: string | undefined; /** `true` if this trade offer was created automatically from a real-time trade that was committed, `false` if it was explicitly sent as a trade offer */ fromRealTimeTrade: boolean | undefined; /** If this offer needs to be confirmed by you, this is a value from EConfirmationMethod */ confirmationMethod: EConfirmationMethod; escrowEndsAt: Date | undefined; countering?: string; /** milliseconds. if set before sending, this offer will be automatically cancelled after this amount of time passed. */ cancelTime?: number; /** milliseconds. if set before sending, this offer will be automatically cancelled after this amount of time passed (when still pending). */ pendingCancelTime?: number; /** the token used to create an offer. usually available in user's trade url */ private _token: string | undefined;
public get token() { return this._token; }
constructor( manager: TradeManager, partner: string | SteamID, token?: string, ) { this.manager = manager;
if (typeof partner === "string") { if (partner !== INTERNAL_USE_FLAG) { this.partner = new SteamID(partner); } } else if (partner) { this.partner = partner; }
this._token = token;
if ( partner !== INTERNAL_USE_FLAG && (!this.partner || !this.partner.isValid() || this.partner.type !== SteamID.Type.INDIVIDUAL) ) { throw new Error("Invalid input SteamID " + this.partner); }
this.state = ETradeOfferState.Invalid; this.itemsToGive = []; this.itemsToReceive = []; this.isOurOffer = undefined; this.escrowEndsAt = undefined; this.confirmationMethod = EConfirmationMethod.None; }
getState() { return ETradeOfferState[this.state]; }
getConfirmationMethod() { return EConfirmationMethod[this.confirmationMethod]; }
containsItem(item: EconItem | RequiredItemProps) { return this.itemsToGive.some((_item) => _item.equals(item)) || this.itemsToReceive.some((_item) => _item.equals(item)); }
/** * @param msg - cannot be longer than 128 characters */ setMessage(msg: string) { if (this.id) { throw new Error("Cannot set message in an already-sent offer"); }
this.message = msg.toString().substring(0, 128); }
setToken(token: string) { if (this.id) { throw new Error("Cannot set token in an already-sent offer"); }
this._token = token; }
counter() { if (this.state !== ETradeOfferState.Active) { throw new Error("Cannot counter a non-active offer."); }
const offer = this.duplicate(); offer.countering = this.id; return offer; }
duplicate() { if (this.state !== ETradeOfferState.Active) { throw new Error("Cannot duplicate a non-active offer."); }
const offer = new TradeOffer(this.manager, this.partner!, this._token); offer.itemsToGive = this.itemsToGive.slice(); offer.itemsToReceive = this.itemsToReceive.slice(); offer.isOurOffer = true; offer.fromRealTimeTrade = false; return offer; }
isGlitched() { if (!this.id) { // not sent yet return false; }
if (this.itemsToGive.length + this.itemsToReceive.length == 0) { return true; }
// Is any item missing its name? // Note: getting the description is optional. if ( this.manager.getDescriptions && (this.itemsToGive.some(hasNoName) || this.itemsToReceive.some(hasNoName)) ) { return true; }
return false; }
isGiftToMe() { if (!this.isOurOffer && this.id && this.itemsToGive.length === 0) { return true; } return false; }
/** do not use this method to update an offer. it is used internally. */ private async _update(data: Offer) { this.id = data.tradeofferid.toString(); if (!this.partner) { this.partner = new SteamID("[U:1:" + data.accountid_other + "]"); } this.message = data.message; this.state = data.trade_offer_state; const fromOfferItemOptions: FromOfferItemOptions = { getDescriptions: this.manager.getDescriptions, language: this.manager.languageName, steamApi: this.manager.steamApi, };
this.itemsToGive = await EconItem.fromList( data.items_to_give || [], fromOfferItemOptions, ); this.itemsToReceive = await EconItem.fromList( data.items_to_receive || [], fromOfferItemOptions, );
this.isOurOffer = data.is_our_offer; this.created = new Date(data.time_created * 1000); this.updated = new Date(data.time_updated * 1000); this.expires = new Date(data.expiration_time * 1000); this.tradeID = data.tradeid?.toString() || undefined; this.fromRealTimeTrade = data.from_real_time_trade; this.confirmationMethod = data.confirmation_method || EConfirmationMethod.None; this.escrowEndsAt = data.escrow_end_date ? new Date(data.escrow_end_date * 1000) : undefined; }
private itemMapper(item: EconItem) { return { "appid": item.appid, "contextid": item.contextid, "amount": item.amount || 1, "assetid": item.assetid, }; }
async send(): Promise<ETradeOfferState> { if (this.id) { throw new Error("This offer has already been sent"); }
if (!this.partner) { throw new Error("This offer has no partner (this should not happen)"); }
if (this.itemsToGive.length + this.itemsToReceive.length == 0) { throw new Error("Cannot send an empty trade offer"); }
const offerdata = { "newversion": true, "version": this.itemsToGive.length + this.itemsToReceive.length + 1, "me": { "assets": this.itemsToGive.map(this.itemMapper), "currency": [], // TODO unknown "ready": false, }, "them": { "assets": this.itemsToReceive.map(this.itemMapper), "currency": [], "ready": false, }, };
const offerCreateParams: Record<string, string> = {};
if (this.token) { offerCreateParams.trade_offer_access_token = this.token; } let response; try { this.manager.pendingSendOffersCount++;
response = await this.manager.steamCommunity.fetch( "https://steamcommunity.com/tradeoffer/new/send", { headers: { "referer": `https://steamcommunity.com/tradeoffer/${(this.id || "new")}/?partner=${this.partner.accountid}` + (this.token ? "&token=" + this.token : ""), }, form: { "sessionid": this.manager.steamCommunity.getSessionID(), "serverid": "1", "partner": this.partner.toString(), "tradeoffermessage": this.message || "", "json_tradeoffer": JSON.stringify(offerdata), "captcha": "", "trade_offer_create_params": JSON.stringify(offerCreateParams), "tradeofferid_countered": this.countering ? this.countering : "", }, }, ); } finally { this.manager.pendingSendOffersCount--; }
const body = await response.json();
if (body && body.tradeofferid) { this.id = body.tradeofferid as string; this.state = ETradeOfferState.Active; this.created = new Date(); this.updated = new Date(); this.expires = new Date(Date.now() + 1209600000); // 2 weeks
// poll data will be saved on next poll if saving method is defined and polling is started this.manager.dataPoller.pollData.sent[this.id] = this.state; if (this.cancelTime !== undefined) { this.manager.dataPoller.pollData.cancelTimes[this.id] = this.cancelTime; } if (this.pendingCancelTime !== undefined) { this.manager.dataPoller.pollData.pendingCancelTimes[this.id] = this.pendingCancelTime; } }
if (body && body.needs_email_confirmation) { this.state = ETradeOfferState.CreatedNeedsConfirmation; this.confirmationMethod = EConfirmationMethod.Email; }
if (body && body.needs_mobile_confirmation) { this.state = ETradeOfferState.CreatedNeedsConfirmation; this.confirmationMethod = EConfirmationMethod.MobileApp; }
if (body && this.state === ETradeOfferState.CreatedNeedsConfirmation) { return ETradeOfferState.CreatedNeedsConfirmation; } else if (body && body.tradeofferid) { return ETradeOfferState.Active; } else { throw new Error("Unknown response"); } }
async decline() { if (!this.id) { throw new Error("Cannot cancel or decline an unsent offer"); }
if ( this.state !== ETradeOfferState.Active && this.state !== ETradeOfferState.CreatedNeedsConfirmation ) { throw new Error( `Offer #${this.id} is not active, so it may not be cancelled or declined`, ); }
let serviceRequest: ServiceRequest; if (this.isOurOffer) { serviceRequest = new CancelTradeOffer(this.id); } else { serviceRequest = new DeclineTradeOffer(this.id); } await this.manager.steamApi.fetch(serviceRequest);
this.state = this.isOurOffer ? ETradeOfferState.Canceled : ETradeOfferState.Declined; this.updated = new Date(); this.manager.dataPoller.doPoll(); }
/** alias for decline() */ cancel() { return this.decline(); }
async accept( skipStateUpdate = false, ): Promise<"accepted" | "pending" | "escrow" | string> { if (!this.id) { throw new Error("Cannot accept an unsent offer"); }
if (!this.partner) { throw new Error( "Offer accept failed: this offer has no partner (this should not happen)", ); }
if (this.state !== ETradeOfferState.Active) { throw new Error( `Offer #${this.id} is not active, so it may not be accepted`, ); }
if (this.isOurOffer) { throw new Error(`Cannot accept our own offer #${this.id}`); }
const response = await this.manager.steamCommunity.fetch( `https://steamcommunity.com/tradeoffer/${this.id}/accept`, { headers: { "Referer": `https://steamcommunity.com/tradeoffer/${this.id}/`, }, form: { "sessionid": this.manager.steamCommunity.getSessionID(), "serverid": "1", "tradeofferid": this.id, "partner": this.partner.toString(), "captcha": "", }, }, );
const body = await response.json();
if (response.status !== 200) { if (response.status === 403) { const err = new Error("Not Logged In"); this.manager.steamCommunity._notifySessionExpired(err); throw err; } else { throw new SteamError("HTTP error " + response.status, { eresult: body?.eresult || -1, body: body, }); } }
throwIfHasError(body);
this.manager.dataPoller.doPoll();
if (body.tradeid) { this.tradeID = body.tradeid; }
if (body?.needs_email_confirmation) { this.confirmationMethod = EConfirmationMethod.Email; }
if (body?.needs_mobile_confirmation) { this.confirmationMethod = EConfirmationMethod.MobileApp; }
if (!skipStateUpdate) { await this.update();
if ( this.confirmationMethod !== undefined && this.confirmationMethod !== EConfirmationMethod.None ) { return "pending"; // deno-lint-ignore ban-ts-comment //@ts-ignore } else if (this.state === ETradeOfferState.InEscrow) { return "escrow"; // deno-lint-ignore ban-ts-comment //@ts-ignore } else if (this.state === ETradeOfferState.Accepted) { return "accepted"; } else { return "unknown state " + this.state; } }
if (body?.needs_email_confirmation || body?.needs_mobile_confirmation) { return "pending"; } else { return "accepted"; } }
async update() { if (!this.id) throw new Error("Cannot update an unsent offer"); try { const body = await this.manager.steamApi.fetch( new GetTradeOffer(this.id), ); // the check is done inside the Service Request. await this._update(body!.response!.offer!); } catch (err) { throw new Error("Cannot load offer data: " + err.message); } }
/** * * @param getDetailsIfFailed - If `false` and the trade's state is anything but `Complete`, `InEscrow`, or `EscrowRollback`, * then the callback will report an error instead of returning the data to you. * This is intended to prevent ignorant developers from blindly trusting the data they get without verifying that * the trade has completed successfully. Defaults to `false`. */ async getExchangeDetails(getDetailsIfFailed = false) { if (!this.id) { throw new Error("Cannot get trade details for an unsent trade offer"); }
if (!this.tradeID) { throw new Error("No trade ID; unable to get trade details"); }
const resp = await this.manager.steamApi.fetch( new GetTradeStatus(this.tradeID), );
const trade = resp!.response!.trades![0]; // checked by steamapi post process
if ( !getDetailsIfFailed && [ ETradeStatus.Complete, ETradeStatus.InEscrow, ETradeStatus.EscrowRollback, ].indexOf(trade.status) ) { throw new Error( "Trade status is " + (ETradeStatus[trade.status] || trade.status), ); }
let sentItems; let receivedItems;
if (this.manager.getDescriptions) { const fromOfferItemOptions: FromOfferItemOptions = { getDescriptions: this.manager.getDescriptions, language: this.manager.languageName, steamApi: this.manager.steamApi, }; sentItems = trade.assets_given ? await EconItem.fromList(trade.assets_given, fromOfferItemOptions) : [] as EconItem[]; receivedItems = trade.assets_received ? await EconItem.fromList(trade.assets_received, fromOfferItemOptions) : [] as EconItem[]; } else { sentItems = trade.assets_given || [] as TradeDetailAsset[]; receivedItems = trade.assets_received || [] as TradeDetailAsset[]; }
return { status: trade.status, sentItems, receivedItems, tradeInitTime: new Date(trade.time_init * 1000), }; }
private offerItemChangeGuard( item?: RequiredItemProps | EconItem, adding = false, ) { if (this.id) { throw new Error("Cannot add/remove item to an already-sent offer"); } if (adding) { if (!item) { throw new Error("Cannot add undefined item to offer"); } if ( typeof item.appid === "undefined" || typeof item.contextid === "undefined" || typeof item.assetid === "undefined" ) { throw new Error("Missing appid, contextid, or assetid parameter"); } } }
addMyItem( item: RequiredItemProps | EconItem, ) { this.offerItemChangeGuard(item, true); if (item instanceof EconItem) { this.itemsToGive.push(item); } else { this.itemsToGive.push(new EconItem(item)); } }
addMyItems( items: Array<RequiredItemProps | EconItem>, ) { items.forEach((item) => this.addMyItem(item)); }
removeMyItem(item: RequiredItemProps | EconItem) { this.offerItemChangeGuard(item); const indexOfItem = this.itemsToGive.findIndex((_item) => _item.equals(item) ); if (indexOfItem !== -1) { this.itemsToGive.splice(indexOfItem, 1); } }
removeMyItems(items: Array<RequiredItemProps | EconItem>) { items.forEach((item) => this.removeMyItem(item)); }
addTheirItem( item: RequiredItemProps | EconItem, ) { this.offerItemChangeGuard(item, true); if (item instanceof EconItem) { this.itemsToReceive.push(item); } else { this.itemsToReceive.push(new EconItem(item)); } }
addTheirItems( items: Array<RequiredItemProps | EconItem>, ) { items.forEach((item) => this.addTheirItem(item)); }
removeTheirItem(item: RequiredItemProps | EconItem) { this.offerItemChangeGuard(item); const indexOfItem = this.itemsToReceive.findIndex((_item) => _item.equals(item) ); if (indexOfItem !== -1) { this.itemsToReceive.splice(indexOfItem, 1); } }
removeTheirItems(items: Array<RequiredItemProps | EconItem>) { items.forEach((item) => this.removeTheirItem(item)); this.removeTheirItem({ appid: 313, contextid: "2", assetid: "1213" }); }
/** Confirms an offer that is in `CreatedNeedsConfirmation` state. * * throws error if offer is unsent, not in `CreatedNeedsConfirmation` state or confirmation object for offerid is not found */ async confirm() { if (!this.id) { throw new Error("Cannot confirm an unsent offer"); } if (this.state !== ETradeOfferState.CreatedNeedsConfirmation) { throw new Error( "Cannot confirm an offer that is not in CreatedNeedsConfirmation state", ); } await this.manager.steamCommunity.confirmationService.allowOffer(this.id); }
static async from( manager: TradeManager, data: Offer, ) { const offer = new TradeOffer( manager, new SteamID("[U:1:" + data.accountid_other + "]"), ); await offer._update(data); return offer; }
static async fromOfferId( manager: TradeManager, offerid: string, ) { const offer = new TradeOffer( manager, INTERNAL_USE_FLAG, ); offer.id = offerid; await offer.update(); return offer; }}