Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Reference — Core SDK: Accounts · Boson Protocol
Skip to content

Accounts mixin

Class: AccountsMixin

Source: packages/core-sdk/src/accounts/mixin.ts

Methods (33)

addFeesToDisputeResolver, addRoyaltyRecipients, addSellersToDisputeResolverAllowList, createBuyer, createDisputeResolver, createNewCollection, createSeller, createSellerAndOffer, getBuyerById, getBuyers, getDisputeResolverById, getDisputeResolverIdFromLogs, getDisputeResolvers, getOfferCollections, getPendingSellerUpdateFromLogs, getRoyaltyRecipients, getSellerByAdmin, getSellerByAssistant, getSellerByAuthToken, getSellerById, getSellers, getSellersByAddress, getSellersByTreasury, optInToDisputeResolverUpdate, optInToSellerUpdate, removeFeesFromDisputeResolver, removeRoyaltyRecipients, removeSellersFromDisputeResolverAllowList, searchSellerFromAuthToken, updateDisputeResolver, updateRoyaltyRecipients, updateSeller, updateSellerAndOptIn

Signatures

addFeesToDisputeResolver (3 signatures)

Overload: returnTxInfo is true → returns TransactionRequest

public async addFeesToDisputeResolver(
    disputeResolverId: BigNumberish,
    fees: accounts.DisputeResolutionFee[],
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo: true;
    }>
  ): Promise<TransactionRequest>
 
public async addFeesToDisputeResolver(
    disputeResolverId: BigNumberish,
    fees: accounts.DisputeResolutionFee[],
    overrides?: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: false | undefined;
    }>
  ): Promise<TransactionResponse>
 
public async addFeesToDisputeResolver(
    disputeResolverId: BigNumberish,
    fees: accounts.DisputeResolutionFee[],
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: boolean;
    }> = {}
  ): Promise<TransactionResponse | TransactionRequest>

addRoyaltyRecipients (3 signatures)

public async addRoyaltyRecipients(
    sellerId: BigNumberish,
    royaltyRecipients: accounts.RoyaltyRecipientInfo[],
    overrides: Partial<{
      contractAddress: string;
      returnTxInfo: true;
    }>
  ): Promise<TransactionRequest>
 
public async addRoyaltyRecipients(
    sellerId: BigNumberish,
    royaltyRecipients: accounts.RoyaltyRecipientInfo[],
    overrides?: Partial<{
      contractAddress: string;
      returnTxInfo?: false | undefined;
    }>
  ): Promise<TransactionResponse>
 
public async addRoyaltyRecipients(
    sellerId: BigNumberish,
    royaltyRecipients: accounts.RoyaltyRecipientInfo[],
    overrides: Partial<{
      contractAddress: string;
      returnTxInfo?: boolean;
    }> = {}
  ): Promise<TransactionResponse | TransactionRequest>

addSellersToDisputeResolverAllowList (3 signatures)

Overload: returnTxInfo is true → returns TransactionRequest

public async addSellersToDisputeResolverAllowList(
    disputeResolverId: BigNumberish,
    sellerAllowList: BigNumberish[],
    overrides: Partial<{
      returnTxInfo: true;
    }>
  ): Promise<TransactionRequest>
 
public async addSellersToDisputeResolverAllowList(
    disputeResolverId: BigNumberish,
    sellerAllowList: BigNumberish[],
    overrides?: Partial<{
      returnTxInfo?: false | undefined;
    }>
  ): Promise<TransactionResponse>
 
public async addSellersToDisputeResolverAllowList(
    disputeResolverId: BigNumberish,
    sellerAllowList: BigNumberish[],
    overrides: Partial<{
      returnTxInfo?: boolean;
    }> = {}
  ): Promise<TransactionResponse | TransactionRequest>

createBuyer (3 signatures)

Overload: returnTxInfo is true → returns TransactionRequest

public async createBuyer(
    buyerToCreate: accounts.CreateBuyerArgs,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo: true;
    }>
  ): Promise<TransactionRequest>
 
public async createBuyer(
    buyerToCreate: accounts.CreateBuyerArgs,
    overrides?: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: false | undefined;
    }>
  ): Promise<TransactionResponse>
 
public async createBuyer(
    buyerToCreate: accounts.CreateBuyerArgs,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: boolean;
    }> = {}
  ): Promise<TransactionResponse | TransactionRequest>

createDisputeResolver (3 signatures)

Overload: returnTxInfo is true → returns TransactionRequest

public async createDisputeResolver(
    disputeResolverToCreate: accounts.CreateDisputeResolverArgs,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo: true;
    }>
  ): Promise<TransactionRequest>
 
public async createDisputeResolver(
    disputeResolverToCreate: accounts.CreateDisputeResolverArgs,
    overrides?: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: false | undefined;
    }>
  ): Promise<TransactionResponse>
 
public async createDisputeResolver(
    disputeResolverToCreate: accounts.CreateDisputeResolverArgs,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: boolean;
    }> = {}
  ): Promise<TransactionResponse | TransactionRequest>

createNewCollection (3 signatures)

public async createNewCollection(
    collectionToCreate: accounts.CreateCollectionArgs,
    overrides: Partial<{
      contractAddress: string;
      returnTxInfo: true;
    }>
  ): Promise<TransactionRequest>
 
public async createNewCollection(
    collectionToCreate: accounts.CreateCollectionArgs,
    overrides?: Partial<{
      contractAddress: string;
      returnTxInfo?: false | undefined;
    }>
  ): Promise<TransactionResponse>
 
public async createNewCollection(
    collectionToCreate: accounts.CreateCollectionArgs,
    overrides: Partial<{
      contractAddress: string;
      returnTxInfo?: boolean;
    }> = {}
  ): Promise<TransactionResponse | TransactionRequest>

createSeller (3 signatures)

Overload: returnTxInfo is true → returns TransactionRequest

public async createSeller(
    sellerToCreate: accounts.CreateSellerArgs,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo: true;
    }>
  ): Promise<TransactionRequest>
 
public async createSeller(
    sellerToCreate: accounts.CreateSellerArgs,
    overrides?: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: false | undefined;
    }>
  ): Promise<TransactionResponse>
 
public async createSeller(
    sellerToCreate: accounts.CreateSellerArgs,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: boolean;
    }> = {}
  ): Promise<TransactionResponse | TransactionRequest>

createSellerAndOffer (3 signatures)

Overload: returnTxInfo is true → returns TransactionRequest

public async createSellerAndOffer(
    sellerToCreate: accounts.CreateSellerArgs,
    offerToCreate: offers.CreateOfferArgs,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo: true;
    }>
  ): Promise<TransactionRequest>
 
public async createSellerAndOffer(
    sellerToCreate: accounts.CreateSellerArgs,
    offerToCreate: offers.CreateOfferArgs,
    overrides?: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: false | undefined;
    }>
  ): Promise<TransactionResponse>
 
public async createSellerAndOffer(
    sellerToCreate: accounts.CreateSellerArgs,
    offerToCreate: offers.CreateOfferArgs,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: boolean;
    }> = {}
  ): Promise<TransactionResponse | TransactionRequest>

getBuyerById (1 signature)

Returns buyer entity from subgraph.

public async getBuyerById(
    buyerId: BigNumberish,
    queryVars?: accounts.subgraph.SingleBuyerQueryVariables
  ): Promise<subgraph.BuyerFieldsFragment>

getBuyers (1 signature)

Returns buyer entities from subgraph.

public async getBuyers(
    queryVars?: subgraph.GetBuyersQueryQueryVariables
  ): Promise<subgraph.BuyerFieldsFragment[]>

getDisputeResolverById (1 signature)

Returns dispute resolver entity from subgraph.

public async getDisputeResolverById(
    disputeResolverId: BigNumberish,
    queryVars?: accounts.subgraph.SingleDisputeResolverQueryVariables
  ): Promise<subgraph.DisputeResolverFieldsFragment>

getDisputeResolverIdFromLogs (1 signature)

Utility method to retrieve the created exchangeId from logs after calling commitToOffer.

public getDisputeResolverIdFromLogs(logs: Log[]): string | null {
    return getValueFromLogs({
      iface: accounts.iface.bosonAccountHandlerIface,
      logs,
      eventArgsKey: "disputeResolverId",
      eventName: "DisputeResolverCreated"
    })

getDisputeResolvers (1 signature)

Returns dispute resolver entities from subgraph.

public async getDisputeResolvers(
    queryVars?: subgraph.GetDisputeResolversQueryQueryVariables
  ): Promise<subgraph.DisputeResolverFieldsFragment[]>

getOfferCollections (1 signature)

public async getOfferCollections(
    queryVars?: subgraph.GetOfferCollectionsQueryQueryVariables
  ): Promise<subgraph.OfferCollectionFieldsFragment[]>

getPendingSellerUpdateFromLogs (1 signature)

Utility method to retrieve the pending seller update fields from logs after calling updateSeller.

public getPendingSellerUpdateFromLogs(logs: Log[]): {
    sellerId: bigint

getRoyaltyRecipients (1 signature)

public async getRoyaltyRecipients(
    sellerId: BigNumberish,
    overrides: Partial<{
      contractAddress: string;
    }> = {}
  )

getSellerByAdmin (1 signature)

Returns seller entity from subgraph.

public async getSellerByAdmin(
    admin: string,
    queryVars?: subgraph.GetSellersQueryQueryVariables
  ): Promise<subgraph.SellerFieldsFragment>

getSellerByAssistant (1 signature)

Returns seller entity from subgraph.

public async getSellerByAssistant(
    assistant: string,
    queryVars?: subgraph.GetSellersQueryQueryVariables
  ): Promise<subgraph.SellerFieldsFragment>

getSellerByAuthToken (1 signature)

Returns seller entity from subgraph that owns the given auth token (if any).

public async getSellerByAuthToken(
    tokenId: string,
    tokenType: number,
    queryVars?: subgraph.GetSellersQueryQueryVariables
  ): Promise<subgraph.SellerFieldsFragment>

getSellerById (1 signature)

Returns seller entity from subgraph.

public async getSellerById(
    sellerId: BigNumberish,
    queryVars?: accounts.subgraph.SingleSellerQueryVariables
  ): Promise<subgraph.SellerFieldsFragment>

getSellers (1 signature)

Returns seller entities from subgraph.

public async getSellers(
    queryVars?: subgraph.GetSellersQueryQueryVariables
  ): Promise<subgraph.SellerFieldsFragment[]>

getSellersByAddress (1 signature)

Returns seller entity from subgraph. Matches assistant, clerk, admin or treasury.

public async getSellersByAddress(
    address: string,
    queryVars?: subgraph.GetSellersQueryQueryVariables
  ): Promise<subgraph.SellerFieldsFragment[]>

getSellersByTreasury (1 signature)

Returns seller entities from subgraph.

public async getSellersByTreasury(
    treasury: string,
    queryVars?: subgraph.GetSellersQueryQueryVariables
  ): Promise<subgraph.SellerFieldsFragment[]>

optInToDisputeResolverUpdate (3 signatures)

Overload: returnTxInfo is true → returns TransactionRequest

public async optInToDisputeResolverUpdate(
    disputeResolverUpdates: accounts.OptInToDisputeResolverUpdateArgs,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo: true;
    }>
  ): Promise<TransactionRequest>
 
public async optInToDisputeResolverUpdate(
    disputeResolverUpdates: accounts.OptInToDisputeResolverUpdateArgs,
    overrides?: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: false | undefined;
    }>
  ): Promise<TransactionResponse>
 
public async optInToDisputeResolverUpdate(
    disputeResolverUpdates: accounts.OptInToDisputeResolverUpdateArgs,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: boolean;
    }> = {}
  ): Promise<TransactionResponse | TransactionRequest>

optInToSellerUpdate (3 signatures)

Overload: returnTxInfo is true → returns TransactionRequest

public async optInToSellerUpdate(
    sellerUpdates: accounts.OptInToSellerUpdateArgs,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo: true;
    }>
  ): Promise<TransactionRequest>
 
public async optInToSellerUpdate(
    sellerUpdates: accounts.OptInToSellerUpdateArgs,
    overrides?: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: false | undefined;
    }>
  ): Promise<TransactionResponse>
 
public async optInToSellerUpdate(
    sellerUpdates: accounts.OptInToSellerUpdateArgs,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: boolean;
    }> = {}
  ): Promise<TransactionResponse | TransactionRequest>

removeFeesFromDisputeResolver (3 signatures)

Overload: returnTxInfo is true → returns TransactionRequest

public async removeFeesFromDisputeResolver(
    disputeResolverId: BigNumberish,
    feeTokenAddresses: string[],
    overrides: Partial<{
      returnTxInfo: true;
    }>
  ): Promise<TransactionRequest>
 
public async removeFeesFromDisputeResolver(
    disputeResolverId: BigNumberish,
    feeTokenAddresses: string[],
    overrides?: Partial<{
      returnTxInfo?: false | undefined;
    }>
  ): Promise<TransactionResponse>
 
public async removeFeesFromDisputeResolver(
    disputeResolverId: BigNumberish,
    feeTokenAddresses: string[],
    overrides: Partial<{
      returnTxInfo?: boolean;
    }> = {}
  ): Promise<TransactionResponse | TransactionRequest>

removeRoyaltyRecipients (3 signatures)

public async removeRoyaltyRecipients(
    sellerId: BigNumberish,
    royaltyRecipientIds: BigNumberish[],
    overrides: Partial<{
      contractAddress: string;
      returnTxInfo: true;
    }>
  ): Promise<TransactionRequest>
 
public async removeRoyaltyRecipients(
    sellerId: BigNumberish,
    royaltyRecipientIds: BigNumberish[],
    overrides?: Partial<{
      contractAddress: string;
      returnTxInfo?: false | undefined;
    }>
  ): Promise<TransactionResponse>
 
public async removeRoyaltyRecipients(
    sellerId: BigNumberish,
    royaltyRecipientIds: BigNumberish[],
    overrides: Partial<{
      contractAddress: string;
      returnTxInfo?: boolean;
    }> = {}
  ): Promise<TransactionResponse | TransactionRequest>

removeSellersFromDisputeResolverAllowList (3 signatures)

Overload: returnTxInfo is true → returns TransactionRequest

public async removeSellersFromDisputeResolverAllowList(
    disputeResolverId: BigNumberish,
    sellerAllowList: string[],
    overrides: Partial<{
      returnTxInfo: true;
    }>
  ): Promise<TransactionRequest>
 
public async removeSellersFromDisputeResolverAllowList(
    disputeResolverId: BigNumberish,
    sellerAllowList: string[],
    overrides?: Partial<{
      returnTxInfo?: false | undefined;
    }>
  ): Promise<TransactionResponse>
 
public async removeSellersFromDisputeResolverAllowList(
    disputeResolverId: BigNumberish,
    sellerAllowList: string[],
    overrides: Partial<{
      returnTxInfo?: boolean;
    }> = {}
  ): Promise<TransactionResponse | TransactionRequest>

searchSellerFromAuthToken (1 signature)

Returns the seller id found in the subgraph, if any, based on an authTokenId owned by the specified address

public async searchSellerFromAuthToken(
    address: string,
    tokenType: number
  ): Promise<string>

updateDisputeResolver (3 signatures)

Overload: returnTxInfo is true → returns TransactionRequest

public async updateDisputeResolver(
    disputeResolverId: BigNumberish,
    updates: accounts.DisputeResolverUpdates,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo: true;
    }>
  ): Promise<TransactionRequest>
 
public async updateDisputeResolver(
    disputeResolverId: BigNumberish,
    updates: accounts.DisputeResolverUpdates,
    overrides?: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: false | undefined;
    }>
  ): Promise<TransactionResponse>
 
public async updateDisputeResolver(
    disputeResolverId: BigNumberish,
    updates: accounts.DisputeResolverUpdates,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: boolean;
    }> = {}
  ): Promise<TransactionResponse | TransactionRequest>

updateRoyaltyRecipients (3 signatures)

public async updateRoyaltyRecipients(
    sellerId: BigNumberish,
    royaltyRecipientIds: BigNumberish[],
    royaltyRecipients: accounts.RoyaltyRecipientInfo[],
    overrides: Partial<{
      contractAddress: string;
      returnTxInfo: true;
    }>
  ): Promise<TransactionRequest>
 
public async updateRoyaltyRecipients(
    sellerId: BigNumberish,
    royaltyRecipientIds: BigNumberish[],
    royaltyRecipients: accounts.RoyaltyRecipientInfo[],
    overrides?: Partial<{
      contractAddress: string;
      returnTxInfo?: false | undefined;
    }>
  ): Promise<TransactionResponse>
 
public async updateRoyaltyRecipients(
    sellerId: BigNumberish,
    royaltyRecipientIds: BigNumberish[],
    royaltyRecipients: accounts.RoyaltyRecipientInfo[],
    overrides: Partial<{
      contractAddress: string;
      returnTxInfo?: boolean;
    }> = {}
  ): Promise<TransactionResponse | TransactionRequest>

updateSeller (3 signatures)

Overload: returnTxInfo is true → returns TransactionRequest

public async updateSeller(
    sellerUpdates: accounts.UpdateSellerArgs,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo: true;
    }>
  ): Promise<TransactionRequest>
 
public async updateSeller(
    sellerUpdates: accounts.UpdateSellerArgs,
    overrides?: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: false | undefined;
    }>
  ): Promise<TransactionResponse>
 
public async updateSeller(
    sellerUpdates: accounts.UpdateSellerArgs,
    overrides: Partial<{
      contractAddress: string;
      txRequest: TransactionRequest;
      returnTxInfo?: boolean;
    }> = {}
  ): Promise<TransactionResponse | TransactionRequest>

updateSellerAndOptIn (1 signature)

Updates seller account by calling the AccountHandlerFacet contract, then optIn for all updates doable by the same account. Only callable by admin.

public async updateSellerAndOptIn(
    sellerUpdates: accounts.UpdateSellerArgs,
    overrides: Partial<{
      contractAddress: string;
    }> = {}
  ): Promise<TransactionResponse>

Related