@superfluid-finance/sdk-core
Version:
SDK Core for building with Superfluid Protocol
234 lines • 10.5 kB
JavaScript
"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const ethers_1 = require("ethers");
const Operation_1 = __importDefault(require("./Operation"));
const SFError_1 = require("./SFError");
const typechain_types_1 = require("./typechain-types");
const utils_1 = require("./utils");
class ERC721MetadataToken {
constructor(address) {
/** ### ERC721 Token Contract Read Functions ### */
/**
* Returns the ERC721 balanceOf the `owner`.
* @param owner the owner you would like to query
* @param providerOrSigner a provider or signer for executing a web3 call
* @returns {Promise<string>} the token balance of `owner`
*/
this.balanceOf = async (params) => {
try {
const normalizedOwner = (0, utils_1.normalizeAddress)(params.owner);
const balanceOf = await this.contract
.connect(params.providerOrSigner)
.balanceOf(normalizedOwner);
return balanceOf.toString();
}
catch (err) {
throw new SFError_1.SFError({
type: "NFT_READ",
message: "There was an error getting balanceOf",
cause: err,
});
}
};
/**
* Returns the owner of the NFT specified by `tokenId`.
* NOTE: Throws if `tokenId` is not a valid NFT.
* @param tokenId the token id
* @param providerOrSigner a provider or signer for executing a web3 call
* @returns {string} the address of the owner of the NFT
*/
this.ownerOf = async (params) => {
try {
const ownerOf = await this.contract
.connect(params.providerOrSigner)
.ownerOf(params.tokenId);
return ownerOf.toString();
}
catch (err) {
throw new SFError_1.SFError({
type: "NFT_READ",
message: "There was an error getting ownerOf",
cause: err,
});
}
};
/**
* Returns the approved address for a single NFT, or the zero address if there is none.
* @param tokenId the token id
* @param providerOrSigner a provider or signer for executing a web3 call
* @returns {string} the approved address for this NFT, or the zero address if there is none
*/
this.getApproved = async (params) => {
try {
const approved = await this.contract
.connect(params.providerOrSigner)
.getApproved(params.tokenId);
return approved;
}
catch (err) {
throw new SFError_1.SFError({
type: "NFT_READ",
message: "There was an error getting getApproved",
cause: err,
});
}
};
/**
* Returns whether `operator` is approved for all of `owner`'s NFTs.
* @param owner the owner of NFTs
* @param operator an operator for the owner's NFTs
* @param providerOrSigner a provider or signer for executing a web3 call
* @returns {bool}
*/
this.isApprovedForAll = async (params) => {
try {
const normalizedOwner = (0, utils_1.normalizeAddress)(params.owner);
const normalizedOperator = (0, utils_1.normalizeAddress)(params.operator);
const approved = await this.contract
.connect(params.providerOrSigner)
.isApprovedForAll(normalizedOwner, normalizedOperator);
return approved;
}
catch (err) {
throw new SFError_1.SFError({
type: "NFT_READ",
message: "There was an error getting isApprovedForAll",
cause: err,
});
}
};
/**
* Returns the token name
* @param providerOrSigner a provider or signer for executing a web3 call
* @returns {string} the token name
*/
this.name = async ({ providerOrSigner, }) => {
try {
const name = await this.contract.connect(providerOrSigner).name();
return name;
}
catch (err) {
throw new SFError_1.SFError({
type: "NFT_READ",
message: "There was an error getting name",
cause: err,
});
}
};
/**
* Returns the token symbol
* @param providerOrSigner a provider or signer for executing a web3 call
* @returns {string} the token symbol
*/
this.symbol = async ({ providerOrSigner, }) => {
try {
const symbol = await this.contract
.connect(providerOrSigner)
.symbol();
return symbol;
}
catch (err) {
throw new SFError_1.SFError({
type: "NFT_READ",
message: "There was an error getting symbol",
cause: err,
});
}
};
/**
* Returns the token URI
* @param tokenId the token id
* @returns {string}
*/
this.tokenURI = async (params) => {
try {
const uri = await this.contract
.connect(params.providerOrSigner)
.tokenURI(params.tokenId);
return uri;
}
catch (err) {
throw new SFError_1.SFError({
type: "NFT_READ",
message: "There was an error getting tokenURI",
cause: err,
});
}
};
/** ### ERC721 Token Contract Write Functions ### */
/**
* Approve `approved` to spend `tokenId` NFT.
* @param approved The receiver approved.
* @param tokenId The tokenId approved.
* @param overrides ethers overrides object for more control over the transaction sent.
* @returns {Operation} An instance of Operation which can be executed.
*/
this.approve = (params) => {
const normalizedReceiver = (0, utils_1.normalizeAddress)(params.approved);
const txn = this.contract.populateTransaction.approve(normalizedReceiver, params.tokenId, params.overrides || {});
return new Operation_1.default(txn, "UNSUPPORTED");
};
/**
* Approve `operator` to spend all NFTs of the signer (`msg.sender`).
* @param operator The operator approved.
* @param approved The approved status.
* @returns {Operation} An instance of Operation which can be executed.
*/
this.setApprovalForAll = (params) => {
const normalizedOperator = (0, utils_1.normalizeAddress)(params.operator);
const txn = this.contract.populateTransaction.setApprovalForAll(normalizedOperator, params.approved, params.overrides || {});
return new Operation_1.default(txn, "UNSUPPORTED");
};
/**
* Transfer `tokenId` from `from` to `to` .
* @param from The owner of the NFT.
* @param to The receiver of the NFT.
* @param tokenId The token to be transferred.
* @param overrides ethers overrides object for more control over the transaction sent.
* @returns {Operation} An instance of Operation which can be executed.
*/
this.transferFrom = (params) => {
const normalizedFrom = (0, utils_1.normalizeAddress)(params.from);
const normalizedTo = (0, utils_1.normalizeAddress)(params.to);
const txn = this.contract.populateTransaction.transferFrom(normalizedFrom, normalizedTo, params.tokenId, params.overrides || {});
return new Operation_1.default(txn, "UNSUPPORTED");
};
/**
* Safe transfer `tokenId` from `from` to `to` (see IERC721.sol OZ Natspec for more details).
* Data is empty in this version of safeTransferFrom.
* @param from The owner of the NFT.
* @param to The receiver of the NFT.
* @param tokenId The token to be transferred.
* @param overrides ethers overrides object for more control over the transaction sent.
* @returns {Operation} An instance of Operation which can be executed.
*/
this.safeTransferFrom = (params) => {
const normalizedFrom = (0, utils_1.normalizeAddress)(params.from);
const normalizedTo = (0, utils_1.normalizeAddress)(params.to);
const txn = this.contract.populateTransaction["safeTransferFrom(address,address,uint256)"](normalizedFrom, normalizedTo, params.tokenId, params.overrides || {});
return new Operation_1.default(txn, "UNSUPPORTED");
};
/**
* Safe transfer `tokenId` from `from` to `to` with `data`.
* @param from The owner of the NFT.
* @param to The receiver of the NFT.
* @param tokenId The token to be transferred.
* @param data The data to be sent with the safe transfer check.
* @param overrides ethers overrides object for more control over the transaction sent.
* @returns {Operation} An instance of Operation which can be executed.
*/
this.safeTransferFromWithData = (params) => {
const normalizedFrom = (0, utils_1.normalizeAddress)(params.from);
const normalizedTo = (0, utils_1.normalizeAddress)(params.to);
const txn = this.contract.populateTransaction["safeTransferFrom(address,address,uint256,bytes)"](normalizedFrom, normalizedTo, params.tokenId, params.data, params.overrides || {});
return new Operation_1.default(txn, "UNSUPPORTED");
};
this.address = address;
this.contract = new ethers_1.ethers.Contract(address, typechain_types_1.IERC721Metadata__factory.abi);
}
}
exports.default = ERC721MetadataToken;
//# sourceMappingURL=ERC721Token.js.map