numbers

README

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

The Numbers Protocol component is an application component 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 definition and tasks are defined in the [definition.json](https://github.com/instill-ai/component/blob/main/application/numbers/v0/config/definition.json) and [tasks.json](https://github.com/instill-ai/component/blob/main/application/numbers/v0/config/tasks.json) files respectively.

## Setup


In order to communicate with Numbers Protocol, the following connection details need to be
provided. You may specify them directly in a pipeline recipe as key-value pairs
within the component's `setup` block, or you can create a **Connection** from
the [**Integration Settings**](https://www.instill.tech/docs/vdp/integration)
page and reference the whole `setup` as `setup:
${connection.<my-connection-id>}`.

<div class="markdown-col-no-wrap" data-col-1 data-col-2>

| Field | Field ID | Type | Note |
| :--- | :--- | :--- | :--- |
| Capture token (required) | `capture-token` | string | Fill in 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.  |

</div>




## Supported Tasks

### Register

Register a file into NumbersProtocol Chain.

<div class="markdown-col-no-wrap" data-col-1 data-col-2>

| 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](#register-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> |
</div>


<details>
<summary> Input Objects in Register</summary>

<h4 id="register-license">License</h4>

License

<div class="markdown-col-no-wrap" data-col-1 data-col-2>

| Field | Field ID | Type | Note |
| :--- | :--- | :--- | :--- |
| License Document | `document` | string | URL of the license file.  |
| License Name | `name` | string | License of the asset file.  |
</div>
</details>



<div class="markdown-col-no-wrap" data-col-1 data-col-2>

| Output | ID | Type | Description |
| :--- | :--- | :--- | :--- |
| Asset Urls | `asset-urls` | array[string] | Asset Urls |
</div>

Documentation

Index

• func Init(bc base.Component) *component
• type CommitCustom
• type CommitCustomLicense
• type CommitCustomMetadata
• type Input
• type Meta
• type Output
• type Register

Functions

func Init

func Init(bc base.Component) *component

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
	Headline        *string
	NITCommitCustom *CommitCustom
	Meta
}