nubit_da_sdk

README

Nubit-da-sdk

Warning! This release is specifically for the Pre-alpha Testnet and may include changes that are not backward compatible in the future.

Background

nubit-da-sdk equips developers with the necessary tools and libraries to efficiently interact with the Nubit Data Availability (DA) Chain. It streamlines complex blockchain functionalities into easy-to-use operations.

What is Nubit-da-sdk?

nubit-da-sdk is an all-encompassing Golang SDK for the Nubit DA Chain. It simplifies the complex processes of blockchain interactions into user-friendly API calls. The SDK covers various of blockchain functionalities, from generating wallets to managing data in namespaces. It's designed to streamline blockchain operations for developers, fostering easy development and integration within the Nubit ecosystem. This SDK is essential for anyone looking to build applications on the Nubit platform, providing a robust set of tools to efficiently handle various blockchain-related tasks.

Getting Started

To use nubit-da-sdk, you will need Golang installed on your system. Follow the steps below to set up and start using the SDK. Go version 1.22.0 or later is required for running repository. Please visit Golang download Page to get latest Golang installed.

1. Install Dependencies

Dependencies are managed through Go Modules. To install all required dependencies, navigate to your project directory and run:

go mod tidy

2. Initialize SDK

To start using the nubit-da-sdk, create a new instance and set it up with your network preferences and private key. You have the option to use the Lightning Network for transaction fee payments, or a gas code (limited to pre-alpha testnet):

// Initialize context and SDK settings
ctx := context.Background()
// Set network to pre-alpha testnet
sdk.SetNet(constant.PreAlphaTestNet)
// Replace "your_gas_code" and "your_private_key" with actual values
client := sdk.NewNubit(sdk.WithCtx(ctx),
    sdk.WithGasCode("your_gas_code"),
    sdk.WithPrivateKey("your_private_key"))
if client == nil {
    panic("client is nil") // Panic if the client creation fails
}

Expected Outcome: This script initializes your SDK client. If successful, it returns "SDK client successfully initialized".

3. Create a Namespace

Namespaces are essential in nubit-da-sdk for organizing your data. Here's how to create one:

// Replace "namespace_name" and "PrivacySetting" with actual values
// "PrivacySetting" should be either "Public" or "Private"
// "owners_address" should be the wallet address of the namespace owner, it could be empty to set the sender as the owner.
// "additional_admins" can be an array of addresses who can administer the namespace
ns, err := client.CreateNamespace("namespace_name", "PrivacySetting", "owners_address", []string{"additional_admins"})
if err != nil {
    panic(err) // Handle the error appropriately
}

// Wait for the new block.
time.Sleep(time.Second * 25)

tx, err := client.Client.GetTransaction(ctx, &types.GetTransactionReq {
    TxID: ns.TxID,
})

if err != nil {
    panic(err) // Handle the error appropriately
}

fmt.Printf("Created Namespace: %s", tx.NID)

Expected Outcome: The script creates a new namespace and returns its ID if successful.

4. Publish Data to Namespace

Once you have a namespace, you can start publishing data to it:

// The path to the file you wish to publish
filePath := "/path/to/your/file"
// The namespace ID where you wish to publish the data
namespaceID := "0x00000001"
// Replace "0" with the transaction fee if you wish to specify it
// Using "0" will automatically calculate the necessary fee
publish, err := client.Upload(filePath, namespaceID, 0)
if err != nil {
    panic(err) // Handle the error appropriately
}
fmt.Println("Uploaded data:", publish)

Expected Outcome: The script publishes a file to the specified namespace and provides a transaction ID upon successful publish.

FAQ

• Q: How do I integrate nubit-da-sdk into my project?

  • A: Start by ensuring your system has Golang installed. Follow our "Getting Started" guide to integrate nubit-da-sdk into your project. This involves installing dependencies, initializing the SDK, setting up network preferences, and creating namespaces for data organization.

• Q: Where can I get help if I encounter issues with nubit-da-sdk?

  • A: First, ensure you're following the documentation correctly. If the issue persists, seek help through our community forums, GitHub issues, or contact our technical support. We're here to assist with any SDK-related queries or difficulties.

• Q: What is nubit-da-sdk's approach to data availability and large-scale data publishing?

  • A: nubit-da-sdk prioritizes data availability using Data Availability Sampling (DAS), facilitating efficient data publishing within namespaces. It ensures data is accessible for a specific period, focusing on availability rather than long-term storage. Transaction fees for data operations are either auto-calculated or can be manually set.

• Q: Can I use nubit-da-sdk for Lightning Network payments?

  • A: Yes, nubit-da-sdk supports Lightning Network transactions, enabling fast and efficient micropayments on the blockchain. You can integrate Lightning payment functionalities into your application using the SDK, providing a seamless user experience for transactions.

• Q: What kind of blockchain operations can I perform with nubit-da-sdk?

  • A: The SDK is designed for a wide range of blockchain operations, including creating and managing wallets, executing and tracking transactions, and managing namespaces for organizing data.

Documentation

Index

• func SetNet(netstr string)
• type NubitSDK
  • func NewNubit(opts ...Opt) *NubitSDK
  • func (sdk *NubitSDK) CreateNamespace(name, permission, owner string, admins []string) (data *types.DataUploadRsp, err error)
  • func (sdk *NubitSDK) GetEstimateFee(req any, method string, nid string) (data *types.EstimateFee, err error)
  • func (sdk *NubitSDK) UpdateNamespace(nid, name, permission, owner string, admins []string) (data *types.DataUploadRsp, err error)
  • func (sdk *NubitSDK) Upload(filePath string, nid string, StorageFee uint64) (target *types.DataUploadRsp, err error)
  • func (sdk *NubitSDK) UploadBytes(data []byte, nid string, StorageFee uint64, Labels map[string]interface{}) (target *types.DataUploadRsp, err error)
• type Opt
  • func WithApprove(Approve int) Opt
  • func WithCtx(ctx context.Context) Opt
  • func WithGasCode(code string) Opt
  • func WithLndProxy(target string) Opt
  • func WithLndTarget(target string) Opt
  • func WithMacaroonFile(file string) Opt
  • func WithPrivateKey(privateKey string) Opt
  • func WithRpc(rpc string) Opt
• type Option

Functions

func SetNet

func SetNet(netstr string)

Types

type NubitSDK

type NubitSDK struct {
	Client *client.Client
	Opts   *Option
}

func NewNubit

func NewNubit(opts ...Opt) *NubitSDK

func (*NubitSDK) CreateNamespace

func (sdk *NubitSDK) CreateNamespace(name, permission, owner string, admins []string) (data *types.DataUploadRsp, err error)

func (*NubitSDK) GetEstimateFee

func (sdk *NubitSDK) GetEstimateFee(req any, method string, nid string) (data *types.EstimateFee, err error)

func (*NubitSDK) UpdateNamespace

func (sdk *NubitSDK) UpdateNamespace(nid, name, permission, owner string, admins []string) (data *types.DataUploadRsp, err error)

func (*NubitSDK) Upload

func (sdk *NubitSDK) Upload(filePath string, nid string, StorageFee uint64) (target *types.DataUploadRsp, err error)

func (*NubitSDK) UploadBytes

func (sdk *NubitSDK) UploadBytes(data []byte, nid string, StorageFee uint64, Labels map[string]interface{}) (target *types.DataUploadRsp, err error)

type Opt

type Opt func(c *Option)

func WithApprove

func WithApprove(Approve int) Opt

func WithCtx

func WithCtx(ctx context.Context) Opt

func WithGasCode

func WithGasCode(code string) Opt

func WithLndProxy

func WithLndProxy(target string) Opt

func WithLndTarget

func WithLndTarget(target string) Opt

func WithMacaroonFile

func WithMacaroonFile(file string) Opt

func WithPrivateKey

func WithPrivateKey(privateKey string) Opt

func WithRpc

func WithRpc(rpc string) Opt

type Option

type Option struct {
	PaymentParams *types.PaymentParams

	NubitRpc string
	ProxyRpc string
	// contains filtered or unexported fields
}