Ends a listing for NFTs in a batch

Ends a listing for all NFTs in a batch on a marketplace.

await api.send.endNftBatchSale(batchId);

important

You can get the VL_GATEWAY_URL for all networks here.

Example

const { AvnApi, SetupMode, SigningMode } = require("avn-api");
const VL_GATEWAY_URL = "https://gateway.testnet.voucherledger.com";

const singleUserOptions = {
	suri: "0x5392ca60a61aea99fce14358798de93c1bc11c3696a905718738c71fae539c24", // this is from the generated example account
	setupMode: SetupMode.SingleUser,
	signingMode: SigningMode.SuriBased,
};

const avnSdk = new AvnApi(VL_GATEWAY_URL, singleUserOptions);

// follow the link above to learn about EXTERNAL_REF
const EXTERNAL_REF = "https://5DA/gxV";

// Index of the nft within the batch
const INDEX = 1;

// New owner address
const OWNER = "5G7B3...";

// any string can represent the batch Id
const BATCH_ID = "batch_id";

async function main() {
	await avnSdk.init();
	const api = await avnSdk.apis();

	let request_id = await api.send.endNftBatchSale(BATCH_ID);
	// Returns a request id
	console.log(request_id);
}

(async () => {
	await main();
})();

You have now successfully submitted a transaction to the VL to end a listing for all NFTs in a batch.

Example Result

Response: f1710fe7-141f-43c1-b1bb-6ec33d9b3e9a

JSON-RPC

REQUEST POST https://VL_GATEWAY_URL/send

HEADERS Content-Type: application/json Authorization': bearer <awtToken>

REQUEST PARAMS

• relayer [required] - a string representing the relayer's SS58 address
• user [required] - a string representing the user's SS58 address
• payer [required] - a string representing the payer's SS58 address
• batchId [required] - a string representing the batch ID (32 bytes) to check for nonce
• nonce [required] - string integer value of the current proxy nonce of type 'batch'
• proxySignature [required] - a proof signed by the user allowing the transaction to be proxied
• feePaymentSignature [required] - a proof signed by the payer allowing the relayer fees to be paid
• paymentNonce [required] - string integer value of the current payment nonce of the payer

JSON-RPC Example

curl https://VL-GATEWAY-URL/send \
    -X POST \
    -H "Content-Type: application/json" \
    -H "Authorization: bearer <awtToken>" \
    -d '{"jsonrpc":"2.0", "method":"proxyEndNftBatchSale", "params":{"relayer":"5FbUQ2kJWLo...Gyu6UoZaryTh", "user":"5DAgxVxKmnJ...rSVJDdMr", "payer":"5DAgxVxKmnJ...rSVJDdMr", "batchId":"0x899697fff9eccfb4de41ad6...8ddecb11dcf35", "nonce":"10","proxySignature":"0x7e8fb895d9c33fbfd...8ef7a6ddd2a52e6802f40720e192d4ca407d657cdfa703a8ce502e9c4f0feedfc3e5e8b", "feePaymentSignature":"0xaae7983775fc1a5bc...31a12f6ce430941856c1259d520759548281afd465b3d66b7e48e72fc2c8c0a3a5bb9f8fa87", "paymentNonce":"209"}, "id":1}'

result - a request ID that can be queried for the transaction's status

JSON-RPC Output

{
	"jsonrpc": "2.0",
	"id": 1,
	"result": "a3ef1c40-c1be-4beb-9953-357d0ab504a9"
}

---

tip

You can query the state of your transaction here using the returned request id.