numbers

package

v0.15.0-beta Latest Latest Go to latest Published: Apr 25, 2024 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

README ¶

---
title: "Numbers Protocol"
lang: "en-US"
draft: false
description: "Learn about how to set up a VDP Numbers Protocol connector https://github.com/instill-ai/instill-core"
---

The Numbers Protocol component is a application connector that allows users to seamlessly integrate third-party blockchain services through the Numbers Protocol, providing security, verifiability and traceability to data management.
It can carry out the following tasks:

- [Register](#register)

## Release Stage

`Alpha`

## Configuration

The component configuration is defined and maintained [here](https://github.com/instill-ai/component/blob/main/pkg/connector/numbers/v0/config/definition.json).

## Connection

| Field | Field ID | Type | Note |
| :--- | :--- | :--- | :--- |
| Capture token (required) | `capture_token` | string | Fill your Capture token in the Capture App. To access your tokens, you need a Capture App account and you can sign in with email or wallet to acquire the Capture Token. |

## Supported Tasks

### Register

Register a file into NumbersProtocol Chain.

| Input | ID | Type | Description |
| :--- | :--- | :--- | :--- |
| Task ID (required) | `task` | string | `TASK_REGISTER` |
| Images (required) | `images` | array[string] | The images you want to upload to blockchain. |
| Caption | `caption` | string | Caption of the asset. |
| Asset Creator | `asset_creator` | string | Name of the asset creator. |
| Headline | `headline` | string | Headline of the asset |
| Digital Source Type | `digital_source_type` | string | Specify the type of the source. More details <a href="https://docs.numbersprotocol.io/introduction/numbers-protocol/defining-web3-assets/assettree/digitalsourcetype">here</a> |
| Generated By | `generated_by` | string | The AI model used to generate the content. |
| License | `license` | object | License |
| Mining Preference | `mining_preference` | string | Designates the selection made by the asset creators or licensed owners to decide if the asset is suitable for inclusion in a data mining or AI/ML training workflow. More details <a href="https://docs.numbersprotocol.io/introduction/numbers-protocol/defining-web3-assets/assettree/miningpreference">here</a> |

| Output | ID | Type | Description |
| :--- | :--- | :--- | :--- |
| Asset Urls | `asset_urls` | array[string] | Asset Urls |

Documentation ¶

Index ¶

func Init(l *zap.Logger, u base.UsageHandler) *connector
type CommitCustom
type CommitCustomLicense
type CommitCustomMetadata
type Input
type Meta
type Output
type Register

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Init ¶

func Init(l *zap.Logger, u base.UsageHandler) *connector

Types ¶

type CommitCustom ¶

type CommitCustom struct {
	AssetCreator      *string               `json:"assetCreator,omitempty"`
	DigitalSourceType *string               `json:"digitalSourceType,omitempty"`
	MiningPreference  *string               `json:"miningPreference,omitempty"`
	GeneratedThrough  string                `json:"generatedThrough"`
	GeneratedBy       *string               `json:"generatedBy,omitempty"`
	CreatorWallet     *string               `json:"creatorWallet,omitempty"`
	License           *CommitCustomLicense  `json:"license,omitempty"`
	Metadata          *CommitCustomMetadata `json:"instillMetadata,omitempty"`
}

type CommitCustomLicense ¶

type CommitCustomLicense struct {
	Name     *string `json:"name,omitempty"`
	Document *string `json:"document,omitempty"`
}

type CommitCustomMetadata ¶

type CommitCustomMetadata struct {
	Pipeline struct {
		UID    string
		Recipe interface{}
	}
}

type Input ¶

type Input struct {
	Images            []string `json:"images"`
	AssetCreator      *string  `json:"asset_creator,omitempty"`
	Caption           *string  `json:"caption,omitempty"`
	Headline          *string  `json:"headline,omitempty"`
	DigitalSourceType *string  `json:"digital_source_type,omitempty"`
	MiningPreference  *string  `json:"mining_preference,omitempty"`
	GeneratedBy       *string  `json:"generated_by,omitempty"`
	License           *struct {
		Name     *string `json:"name,omitempty"`
		Document *string `json:"document,omitempty"`
	} `json:"license,omitempty"`
}

type Meta ¶

type Meta struct {
	Proof struct {
		Hash      string `json:"hash"`
		MIMEType  string `json:"mimeType"`
		Timestamp string `json:"timestamp"`
	} `json:"proof"`
}

type Output ¶

type Output struct {
	AssetUrls []string `json:"asset_urls"`
}

type Register ¶

type Register struct {
	Caption         *string       `json:"caption,omitempty"`
	Headline        *string       `json:"headline,omitempty"`
	NITCommitCustom *CommitCustom `json:"nit_commit_custom,omitempty"`
	Meta
}

Source Files ¶

View all Source files

main.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL