borsh-go - GitLite

KO | EN

gitlite — search

#javascript #react #ai #typescript #llm #go #deep-learning #linux #docker #nodejs #cli #kubernetes #awesome-list #ios

borsh-go

(★ 69)

Go implementation of Binary Object Representation Serializer for Hashing

파일 탐색기

최종 버전 다운로드 (.zip)

- - BOUNTY.yml
- - go.yml
bench_test.go
borsh.go
borsh_test.go
decoder.go
encoder.go
example_test.go
extend_type.go
fuzz_test.go
go.mod
LICENSE
README.md

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/near/borsh-go

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd borsh-go

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Go

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Go Go 언어 컴파일러 및 도구 모음입니다.

go build ./...

Go 프로그램을 컴파일해 실행 파일을 만듭니다.

go run .

따로 빌드하지 않고 바로 Go 프로그램을 실행합니다.

✅ 빌드가 에러 없이 끝나면 성공입니다. go run . 을 썼다면 터미널 출력을 확인하세요.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# borsh-go

[![Go Reference](https://pkg.go.dev/badge/github.com/near/borsh-go.svg)](https://pkg.go.dev/github.com/near/borsh-go)

**borsh-go** is an implementation of the [Borsh] binary serialization format for Go
projects.

Borsh stands for _Binary Object Representation Serializer for Hashing_. It is
meant to be used in security-critical projects as it prioritizes consistency,
safety, speed, and comes with a strict specification.

## Features

- Based on Go Reflection. Avoids the need for create protocol file and code generation. Simply
defining `struct` and go.

## Usage

### Example

```go
package demo

import (
	"log"
	"reflect"
	"testing"

"github.com/near/borsh-go"
)

type A struct {
	X uint64
	Y string
	Z string `borsh_skip:"true"` // will skip this field when serializing/deserializing
}

func TestSimple(t *testing.T) {
	x := A{
		X: 3301,
		Y: "liber primus",
	}
	data, err := borsh.Serialize(x)
	log.Print(data)
	if err != nil {
		t.Error(err)
	}
	y := new(A)
	err = borsh.Deserialize(y, data)
	if err != nil {
		t.Error(err)
	}
	if !reflect.DeepEqual(x, *y) {
		t.Error(x, y)
	}
}
```

For more examples of usage, refer to `borsh_test.go`.

## Type Mappings

Borsh                 | Go           |  Description
--------------------- | -------------- |--------
`bool`		      | `bool`	       |
`u8` integer          | `uint8`        |
`u16` integer         | `uint16`       |
`u32` integer         | `uint32`       |
`u64` integer         | `uint64`       |
`u128` integer        | `big.Int`  |
`i8` integer          | `int8`        |
`i16` integer         | `int16`       |
`i32` integer         | `int32`       |
`i64` integer         | `int64`       |
`i128` integer        |            |  Not supported yet
`f32` float           | `float32`      |
`f64` float           | `float64`      |
fixed-size array      | `[size]type`   |  go array
dynamic-size array    |  `[]type`      |  go slice
string                | `string`       |
option                |  `*type`         |   go pointer
map                   |   `map`          |
set                   |   `map[type]struct{}`  | go map with value type set to `struct{}`
structs               |   `struct`      |
enum                  |   `borsh.Enum`  |    use `type MyEnum borsh.Enum` to define enum type