Publish a Package

How to publish a package using the TypeScript SDK.

publishPackage function

await supraClient.publishPackage(senderAccount, packageMetadata, modulesCode)

Parameters

Name	Type
senderAccount	SupraAccount
packageMetadata	Uint8Array
modulesCode	Uint8Array[]
optionalTransactionArgs	OptionalTransactionArgs

Returns

Name	Type
Promise<TransactionResponse>	TransactionResponse

TransactionResponse

{
  txHash: '',
  result: ''
}

---

Example

The publishPackage function requires the package metadata and module bytecode as the second and third parameter. These are obtained through the build-publish-payload command of the Supra CLI. Once obtained, parse the JSON file for the data and pass it to the publishPackage function.

1

Build the publish payload with the Supra CLI

supra move tool build-publish-payload --package-dir /supra/configs/move_workspace/{YOUR_PROJECT_NAME} --json-output-file ./configs/move_workspace/{YOUR_PROJECT_NAME}/publish-payload.json

2

Initialize a new project

npm init && npm add -D typescript @types/node ts-node && npx tsc --init

3

Install Supra's TypeScript SDK

npm install supra-l1-sdk

4

Create publish_example.ts and import dependencies

publish_example.ts

import fs from "fs";
import { HexString, SupraAccount, SupraClient } from "supra-l1-sdk";

5

Parse the JSON file and extract data

publish_example.ts

function getPackageData(filePath: string) {
    const jsonData = JSON.parse(fs.readFileSync(filePath, "utf8"));
    const packageMetadata = new HexString(jsonData.args[0].value).toUint8Array();
    const modulesCode = [];

    for(let e of jsonData.args[1].value){
      modulesCode.push(new HexString(e).toUint8Array())
    }
  
    return { packageMetadata, modulesCode };
}

6

Call the publishPackage function

publish_example.ts

async function main(){

    const { packageMetadata, modulesCode } = getPackageData("YOUR_PATH_TO_JSON_FILE");

    let supraClient = await SupraClient.init(
        "https://rpc-testnet.supra.com/"
    );

    let senderAccount = new SupraAccount(
        new HexString("YOUR_PRIVATE_KEY").toUint8Array()
    );

    const publishTxn = await supraClient.publishPackage(senderAccount, packageMetadata, modulesCode)

    console.log(publishTxn);

}

7

Complete code

publish_example.ts

import fs from "fs";
import { HexString, SupraAccount, SupraClient } from "supra-l1-sdk";


function getPackageData(filePath: string) {
    const jsonData = JSON.parse(fs.readFileSync(filePath, "utf8"));
    const packageMetadata = new HexString(jsonData.args[0].value).toUint8Array();
    const modulesCode = [];

    for(let e of jsonData.args[1].value){
      modulesCode.push(new HexString(e).toUint8Array())
    }
  
    return { packageMetadata, modulesCode };
}

async function main(){

    const { packageMetadata, modulesCode } = getPackageData("YOUR_PATH_TO_JSON_FILE");

    let supraClient = await SupraClient.init(
        "https://rpc-testnet.supra.com/"
    );

    let senderAccount = new SupraAccount(
        new HexString("YOUR_PRIVATE_KEY").toUint8Array()
    );

    const publishTxn = await supraClient.publishPackage(senderAccount, packageMetadata, modulesCode)

    console.log(publishTxn);

}

main()

8

Execute code npx ts-node publish_example.ts