HackMD
  • New!
    New!  “Bookmark” and save your note
    Find a note that's worth keeping or want reading it later? “Bookmark” it to your personal reading list.
    Got it
      • Create new note
      • Create a note from template
    • New!  “Bookmark” and save your note
      New!  “Bookmark” and save your note
      Find a note that's worth keeping or want reading it later? “Bookmark” it to your personal reading list.
      Got it
      • Options
      • Versions and GitHub Sync
      • Transfer ownership
      • Delete this note
      • Template
      • Save as template
      • Insert from template
      • Export
      • Dropbox
      • Google Drive
      • Gist
      • Import
      • Dropbox
      • Google Drive
      • Gist
      • Clipboard
      • Download
      • Markdown
      • HTML
      • Raw HTML
      • ODF (Beta)
      • Sharing Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Note Permission
      • Read
        • Owners
        • Signed-in users
        • Everyone
        Owners Signed-in users Everyone
      • Write
        • Owners
        • Signed-in users
        • Everyone
        Owners Signed-in users Everyone
      • More (Comment, Invitee)
      • Publishing
        Everyone on the web can find and read all notes of this public team.
        After the note is published, everyone on the web can find and read this note.
        See all published notes on profile page.
      • Commenting Enable
        Disabled Forbidden Owners Signed-in users Everyone
      • Permission
        • Forbidden
        • Owners
        • Signed-in users
        • Everyone
      • Invitee
      • No invitee
    Menu Sharing Create Help
    Create Create new note Create a note from template
    Menu
    Options
    Versions and GitHub Sync Transfer ownership Delete this note
    Export
    Dropbox Google Drive Gist
    Import
    Dropbox Google Drive Gist Clipboard
    Download
    Markdown HTML Raw HTML ODF (Beta)
    Back
    Sharing
    Sharing Link copied
    /edit
    View mode
    • Edit mode
    • View mode
    • Book mode
    • Slide mode
    Edit mode View mode Book mode Slide mode
    Note Permission
    Read
    Owners
    • Owners
    • Signed-in users
    • Everyone
    Owners Signed-in users Everyone
    Write
    Owners
    • Owners
    • Signed-in users
    • Everyone
    Owners Signed-in users Everyone
    More (Comment, Invitee)
    Publishing
    Everyone on the web can find and read all notes of this public team.
    After the note is published, everyone on the web can find and read this note.
    See all published notes on profile page.
    More (Comment, Invitee)
    Commenting Enable
    Disabled Forbidden Owners Signed-in users Everyone
    Permission
    Owners
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Invitee
    No invitee
       owned this note    owned this note      
    Published Linked with
    Like BookmarkBookmarked
    Subscribed
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    Subscribe
    # Status of Skynet SDKs This document contains the current state of the functionality and documentation of the Skynet SDKs, available in these languages: - Shell (using curl) - [Browser JS](https://github.com/NebulousLabs/skynet-js) - [NodeJS](https://github.com/NebulousLabs/nodejs-skynet) - [Python](https://github.com/NebulousLabs/python-skynet) - [Go](https://github.com/NebulousLabs/go-skynet) as well as the [Skynet CLI](https://github.com/NebulousLabs/skynet-cli) (written in Go). ## Notes * This document may at times be temporarily out of sync with the main documentation. When in doubt, go by the official docs. * Unofficial SDKs are not included. ## Supported functions The following is a list of functionality and whether it is supported by each language. Cells marked by `**` correspond to functionality not yet documented. **Note:** You may need to scroll right to see all SDKs. Functionality | Endpoint | JS | NodeJS | Python | Go | CLI -- | -- | -- | -- | -- | -- | -- **Client** | Create a default client | *n/a* | `SkynetClient()` | `SkynetClient()` | `SkynetClient()` | `skynet.New()` | *n/a* Create a client with custom options | *n/a* | `SkynetClient(portal, opts)` | `SkynetClient(portal, opts)` | `SkynetClient(portal, opts)` | `skynet.NewCustom(portal, opts)` | *n/a* **Uploading** | Upload file | `/skynet/skyfile` [POST] | `uploadFile` | `UploadFile` | `upload_file` | `UploadFile` | `skynet upload` Upload directory | `/skynet/skyfile` [POST] with the `files` field set | `uploadDirectory` | `UploadDirectory` | `upload_directory` | `UploadDirectory` | `skynet upload` Upload file, get full response | `/skynet/skyfile` [POST] | `uploadFileRequest` | **No** | `upload_file_request` | **No** | **No** Upload directory, get full response | `/skynet/skyfile` [POST] | `uploadDirectoryRequest` | **No** | `upload_directory_request` | **No** | **No** Upload generic data | `/skynet/skyfile` [POST] | **Not supported** | **Not supported** | **Not supported** | ** `Upload` | **Not supported** Upload with encryption | ** Yes | **Not supported** | **Not supported** | **Not supported** | `SkykeyName`, `SkykeyID` | `skykey-name`, `skykey-id` **Downloading** | Download file | `/skynet/skylink` [GET] | `downloadFile` / `openFile` | `DownloadFile` | `download_file` | `DownloadFile`| `skynet download` Download directory | ** `/skynet/skylink` [GET] (see `format` parameter) | | | Download skylink headers | `/skynet/skylink` [HEAD] | **Not supported** | **Not supported** | `get_metadata` | **Not supported** | **Not supported** Download generic data | `/skynet/skylink` [GET] | **Not supported** | **Not supported** | **Not supported** | ** `Download` | **Not supported** Download with decryption | ** Yes | **Not supported** | **Not supported** | **Not supported** | `SkykeyName`, `SkykeyID` | `skykey-name`, `skykey-id`**Not supported** | **Not supported** | **Not supported** | **Not supported** | **Not supported** **Encryption** | Add skykey | `/skynet/addskykey` [POST] | **Not supported** | **Not supported** | **Not supported** | `AddSkykey` | `skynet skykey add` Create skykey | `/skynet/createskykey` [POST] | **Not supported** | **Not supported** | **Not supported** | `CreateSkykey` | `skynet skykey create` List all skykeys | `/skynet/skykeys` [GET] | **Not supported** | **Not supported** | **Not supported** | `GetSkykeys` | `skynet skykey list` Get skykey by name | `/skynet/skykey` [GET] | **Not supported** | **Not supported** | **Not supported** | `GetSkykeyByName` | `skynet skykey get name` Get skykey by ID | `/skynet/skykey` [GET] | **Not supported** | **Not supported** | **Not supported** | `GetSkykeyByID` | `skynet skykey get id` **Handshake** | Downloading Handshake files | `/hns` [GET] | `downloadFileHns` Resolving Handshake domains | `/hnsres` [GET] | `resolveHns` ## Supported constants Constant | JS | NodeJS | Python | Go -- | -- | -- | -- | -- Default portal URL | `defaultSkynetPortalUrl` | `defaultPortalUrl` | `defaultPortalUrl()` | `DefaultPortalURL` Skynet URI prefix | `uriSkynetPrefix` | `uri_skynet_prefix` | `uri_skynet_prefix()` | `URISkynetPrefix` ## Tests ### Unit tests Test | JS | NodeJS | Python | Go -- | -- | -- | -- | -- Directory walking | *n/a* | **No** | Yes | Yes URL creation | Yes | Yes | Yes | Yes ### Integration/Mock tests Test | JS | NodeJS | Python | Go -- | -- | -- | -- | -- **Uploading** | Basic file uploads | Yes | Yes | Yes | Yes Basic directory uploads | Yes | Yes | Yes | Yes Upload files with custom names | Yes | Yes | Yes | Yes Upload directories with custom names | Yes | Yes | Yes | Yes Upload with skykey | **No** | **No** | **No** | Yes **Downloading** | Basic file downloads | Yes | Yes | Yes | Yes Download with skykey | **No** | **No** | **No** | Yes **Encryption** | Add skykey | **No** | **No** | **No** | Yes Create skykey | **No** | **No** | **No** | Yes Get skykey by name/id | **No** | **No** | **No** | Yes List skykeys | **No** | **No** | **No** | Yes **Connection Options** | Authentication | Yes | Yes | Yes | Yes Custom User Agent | Request timeouts | **No** | **No** | **No** | **No** ## Misc Misc features | Shell | JS | NodeJS | Python | Go | CLI -- | -- | -- | -- | -- | -- | -- **Uploading** | Custom filename | ** Yes | `customFilename` | `customFilename` | `custom_filename` | `CustomFilename` | `--filename` Custom dirname | ** Yes | `customDirname` | `customDirname` | `custom_dirname` | `CustomDirname` | `--dirname` Default path | ** Yes | **No** | **No** | **No** | **No** | **No** Dryrun | ** Yes | **No** | ** `dryRun` | **No** | **No** | **No** **Downloading** | Path parameter | *n/a* | **Open PR** | **No** | **No** | **No** | **No** **Common Options** | Authentication for all the endpoints | `--user "":"foobar"` | `APIKey` | `APIKey` | `api_key` | `APIKey` | `--api-key` Custom user-agent | `-A "Sia-Agent"` | `customuserAgent` | `customUserAgent` | `custom_user_agent` | `CustomUserAgent` | `--custom-user-agent` Request timeouts | ** Yes (Set the `timeout` field) | **No** | **No** | ** `timeout_seconds` | **No** | **No** Query parameter | *n/a* | **Open PR** | **No** | **No** | **No** | **No** **Uncategorized** | API defined in separate files instead of one file | *n/a* | Yes | Yes | Yes | Yes | **No** Encode URLs when making requests | *n/a* | **Open PR** | **No** | **No** | **No** | **No** ## See Also - [Skynet Docs](https://siasky.net/docs/#introduction) - [Skynet SDK Publishing](https://hackmd.io/JG31576YSlO29Dj4gLkDsA) - [Skynet SDK Testing](/dHSts01AR4WnnOmvZOcRxw)

    Import from clipboard

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lost their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template is not available.
    All
    • All
    • Team
    No template found.

    Create a template

    Delete template

    Do you really want to delete this template?

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password

    or

    By clicking below, you agree to our terms of service.

    Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox Sign in via Google

    New to HackMD? Sign up

    Help

    Documents

    Tutorials
    YAML Metadata
    Slide Example
    Book Example

    Contacts

    Talk to us
    Report an issue
    Send us email

    Cheatsheet

    Example Syntax
    Header # Header
    • Unordered List
    - Unordered List
    1. Ordered List
    1. Ordered List
    • Todo List
    - [ ] Todo List
    Blockquote
    > Blockquote
    Bold font **Bold font**
    Italics font *Italics font*
    Strikethrough ~~Strikethrough~~
    19th 19^th^
    H2O H~2~O
    Inserted text ++Inserted text++
    Marked text ==Marked text==
    Link [link text](https:// "title")
    Image ![image alt](https:// "title")
    Code `Code`
    var i = 0;
    ```javascript
    var i = 0;
    ```
    :smile: :smile:
    Externals {%youtube youtube_id %}
    LaTeX $L^aT_eX$

    This is a alert area.

    :::info
    This is a alert area.
    :::

    Versions

    Versions and GitHub Sync

    Sign in to link this note to GitHub Learn more
    This note is not linked with GitHub Learn more
     
    Add badge Pull Push GitHub Link Settings

    Version named by    

    More Less
    • Edit
    • Delete

    Note content is identical to the latest version.
    Compare with
      Choose a version
      No search result
      Version not found

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub

        Please sign in to GitHub and install the HackMD app on your GitHub repo. Learn more

         Sign in to GitHub

        HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully