README.md

go-mcs-sdk

Table of Contents

• Introduction
  • Functions
  • Data Structures
  • Constants
• Prerequisites
• Usage
  • Download SDK
  • Call SDK
  • Documentation
• MCS API
• Contributing
• Sponsors

Introduction

A Golang software development kit for the Multi-Chain Storage (MCS) Service . It provides a convenient interface for working with the MCS API.

Functions:

• User Functions
• Bucket Functions
• On-chain Functions

Data Structures:

• Struct

Constants:

• Constants

Prerequisites

• Metamask Wallet
• Polygon RPC
• [USDC and MATIC balance]
• Optional: apikey -> Setting -> Create API Key

Usage

Download SDK

go get github.com/filswan/go-mcs-sdk

Call SDK

1. Login using apikey/accessToken

import (
	"github.com/filswan/go-mcs-sdk/mcs/api/user"
)

mcsClient, err := user.LoginByApikeyV2(apikey, network)
// apikey: your apikey
// network: (MCS mainnet: mainnet, MCS testnet: testnet . Default is the main network.)

// mcsClient: result including the information to access the other API(s)
// err: when err generated while accessing this api, the error info will store in err

• See Constants to show optional network

2. Call bucket related api(s)

• Step 1️⃣ Change McsClient to BucketClient

import (
	"github.com/filswan/go-mcs-sdk/mcs/api/bucket"
)
bucketClient := bucket.GetBucketClient(*mcsClient)

• Step 2️⃣ Create a bucket

bucketUid, err := buketClient.CreateBucket([BUCKET_NAME])
// bucketUid: the new created bucket UID
// err: when err generated while accessing this api, the error info will store in err

• Step 3️⃣ Upload a file to the bucket

// err := buketClient.UploadFile([BUCKET_NAME], [YOUR_FILE_NAME], [YOUR_FILE_PATH], true)
// err: when err generated while accessing this api, the error info will store in err

Documentation

For more examples please see the SDK documentation

MCS API

For more information about the API usage, check out the MCS API documentation (https://docs.filswan.com/development-resource/mcp-api).

Contributing

Feel free to join in and discuss. Suggestions are welcome! Open an issue or Join the Discord!

Sponsors

This project is sponsored by Filecoin Foundation

Flink SDK - A data provider offers Chainlink Oracle service for Filecoin Network